### Contents

Introduction
FHEM command types
Device specification
Attributes
FHEM commands

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

Devices

global
alexa ALL3076 ALL4000T ALL4027 allergy AMAD ArduCounter BDKM BOSEST BRAVIA 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 DLNARenderer Dooya DUOFERN DUOFERNSTICK EC3000 ECMD ECMDDevice EDIPLUG EGPM EGPM2LAN EIB EleroDrive EleroStick EM EMEM EMGZ EMT7110 EMWZ ENECSYSGW ENECSYSINV ENIGMA2 EnOcean EQ3BT ESA2000 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 GAEBUS GHoma harmony HEATRONIC Hideki HMCCU HMCCUCHN HMCCUDEV HMLAN HMS HMUARTLGW HOMBOT HP1000 HTTPMOD HUEBridge HUEDevice HXB HXBDevice Hyperion I2C_BH1750 I2C_BME280 I2C_BMP180 I2C_DS1307 I2C_EEPROM I2C_HDC1008 I2C_K30 I2C_LCD I2C_MCP23008 I2C_MCP23017 I2C_MCP342x I2C_MMA845X I2C_PCA9532 I2C_PCA9685 I2C_PCF8574 I2C_SHT21 I2C_SHT3x I2C_TSL2561 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 LGTV_IP12 LIGHTIFY LINDY_HDMI_SWITCH LIRC LUXTRONIK2 M232 M232Counter M232Voltage mailcheck MAX MAXLAN MEDIAPORTAL MilightBridge MilightDevice Modbus ModbusAttr ModbusSET ModbusTrovis5576 MPD MQTT MQTT_BRIDGE MQTT_DEVICE MSGFile MSGMail MYSENSORS MYSENSORS_DEVICE N4HBUS N4HMODULE netatmo NetIO230B Netzer NetzerI2C Nextion 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 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 plex Plugwise POKEYS PROPLANTA Pushalot 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_WS SD_WS07 SD_WS09 SD_WS_Maverick SHC SHCdev SIGNALduino SIGNALduino_un siri SIS_PMS SISPM SMAEM SMAInverter SMARTMON SMASTP SML Snapcast SOMFY SONOS SONOSPLAYER speedtest SSCam STACKABLE_CC STOCKQUOTES STV SWAP SWAP_0000002200000003 SWAP_0000002200000008 SYSMON SYSSTAT tahoma TCM TechemHKV TechemWZ TEK603 TelegramBot TellStick THINKINGCLEANER THZ TPLinkHS110 TRAFFIC TRX TRX_ELSE TRX_LIGHT TRX_SECURITY TRX_WEATHER TUL UbiquitiMP UbiquitiOut Unifi UNIRoll USBWX USF1000 UWZ VantagePro2 VBUSDEV VBUSIF VCONTROL Verkehrsinfo VIERA VolumeLink Weather WEBCOUNT WEBIO WEBIO_12DIGITAL WifiLight withings WMBUS WS2000 WS300 WS3600 Wunderground WWO X10 XBMC XiaomiFlowerSens xxLG7000 YAMAHA_AVR YAMAHA_BD YAMAHA_NP yowsup ZWave ZWCUL ZWDongle

Helper modules

Alarm allowed at autocreate average cloneDummy configDB CustomReadings Dashboard DbLog DbRep dewpoint DOIF DOIFtools dummy ElectricityCalculator eventTypes FB_CALLLIST FB_CALLMONITOR FHEM2FHEM FHEMWEB FileLog FLOORPLAN GasCalculator GEOFANCY GoogleAuth GUEST HCS Heating_Control HMinfo holiday HourCounter HTTPSRV InfoPanel KM271 LightScene logProxy MaxScanner msgConfig notify PachLog PostMe powerMap PRESENCE rain RandomTimer readingsChange readingsGroup readingsHistory readingsProxy remotecontrol RESIDENTS ROOMMATE RSS sequence statistics structure SUNRISE_EL SVG telnet Text2Speech THRESHOLD TrashCal Twilight Utils watchdog weblink WeekdayTimer weekprofile WOL

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 minimal configuration file looks like:

        attr global logfile log/fhem.log
        attr global modpath .
        attr global statefile log/fhem.save
        attr global verbose 3
        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>" "..."`

### 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.
- 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 TYPE=FS20 STATE`
`list i:TYPE=FS20 STATE`

Notes:

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

### Attributes

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

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

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

You can use the command

`attr global userattr <attributelist>`

for the global device to declare new global attributes and

`attr <devicespec> userattr <attributelist>`

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

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

#### Device specific attributes

Device specific attributes are documented in the corresponding device section.

#### Global attributes used by all devices

- alias
  Used by FHEMWEB to display a device with another name e.g. when using special characters/spaces not accepted by device definition.
- comment
  Add an arbitrary comment.
- eventMap
  Replace event names and set arguments. The value of this attribute consists of a list of space separated values, each value is a colon separated pair. The first part specifies the "old" value, the second the new/desired value. If the first character is slash(/) or comma(,) then split not by space but by this character, enabling to embed spaces. Examples:
  `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. Recognized by web-pgm2 and web-pgm3. A device can appear in more than one room, in this case the rooms have to be specified comma-separated.
  Devices in the room hidden will not appear in the web output, or set the FHEMWEB attribute to selectively disable rooms for certain FHEMWEB instances.
- suppressReading
  Used to eliminate unwanted readings. The value is a regular expression, with ^ and $ added. Only necessary in exceptional cases.
- showtime
  Used in the webfrontend pgm2 to show the time of last activity instead of the state in the summary view. Useful e.g. for FS20 PIRI devices.
- verbose
  Set the verbosity level. Possible values:
  - 0 - server start/stop
  - 1 - error messages or unknown packets
  - 2 - major events/alarms.
  - 3 - commands sent out will be logged.
  - 4 - you'll see whats received by the different devices.
  - 5 - debugging.
  The value for the global device is a default for other devices without own verbose attribute set.

#### readingFnAttributes

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

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

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

- 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 <devspec> <attrname> [<value>]`
Set an attribute for a device defined by define. 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.
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`

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 <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 <name> for detailed info.

      Internal:
        global               (Internal)

      FHZ:
        FHZ                  (fhtbuf: 23)

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

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

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

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

      notify:
        ntfy_btn4            (active)

      FileLog:
        avglog               (active)

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.

### 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:reading] with the corresponding reading of device, if both device and reading exists.
- [device:reading:d] same as above, but only the number is retrieved, see ReadingsNum
- {(perlExpression)} with the result of perlExpression. The $DEV variable is additionally available, designating the set device name.

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.

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
- 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.
- dnsServer
  Contains the IP address of the DNS Server. If some of the modules or user code calls the HttpUtils_NonblockingGet function, and this attribute is set, then FHEM specific nonblocking code will be used to resolve the given address. If this attribute is not set, the blocking OS implementation (inet_aton and gethostbyname) will be used.
- holiday2we
  If this attribute is set, then the $we variable will be true, if the value of the holiday variable referenced by this attribute is not none.
  Example:
  attr global holiday2we hessen
- featurelevel
  Enable/disable old or new features, based on FHEM version. E.g. the $value hash for notify is only set for featurelevel up to 5.6, as it is deprecated, use the Value() function instead.
- logdir
  If set, the %L attribute in the logfile attribute (or in the FileLog modules file definition) is replaced wth the value of the attribute. Note: changing the value won't result in moving the files and may cause other problems.
- logfile
  Specify the logfile to write. You can use "-" for stdout, in this case the server won't background itself.
  The logfile name can also take wildcards for easier logfile rotation, see the FileLog section. Just apply the `archivecmd / archivedir / nrarchive` attributes to the `global` device as you would do for a FileLog device.
  You can access the current name of the logfile with `{ $currlogfile }`.
- modpath
  Specify the path to the modules directory `FHEM`. The path does not contain the directory FHEM. Upon setting the attribute, the directory will be scanned for filenames of the form NN_<NAME>.pm, and make them available for device definition under <NAME>. If the first device of type <NAME> is defined, the module will be loaded, and its function with the name <NAME>_Initialize will be called. Exception to this rule are modules with NN=99, these are considered to be utility modules containing only perl helper functions, they are loaded at startup (i.e. modpath attribute definition time).
- motd
  Message Of The Day. Displayed on the homescreen of the FHEMWEB package, or directly after the telnet logon, before displaying the fhem> prompt. SecurityCheck is setting motd if it is not defined upon startup, to avoid this set the motd value to none. motd is also used to show collected error messages upon FHEM start.
- mseclog
  If set, the timestamp in the logfile will contain a millisecond part.
- nofork
  If set and the logfile is not "-", do not try to background. Needed on some Fritzbox installations, and it will be set automatically for Windows.
- pidfilename
  Write the process id of the perl process to the specified file. The server runs as a daemon, and some distributions would like to check by the pid if we are still running. The file will be deleted upon shutdown.
- sendStatistics
- statefile
  Set the filename where the state and certain at information will be saved before shutdown. If it is not specified, then no information will be saved.
- title
- uniqueID
- userattr
  A space separated list which contains the names of additional attributes for all devices. Without specifying them you will not be able to set them (in order to prevent typos).
  userattr can also specified for other devices, in this case these additinal attribute names are only valid for this device.
- dupTimeout
  Define the timeout for which 2 identical events from two different receiver are considered a duplicate. Default is 0.5 seconds.
- showInternalValues
  Show data used for internal computations. If the name of an internal value, reading or attribute starts with dot (.), then it is normally hidden, and will only be visible, if this attribute is set to 1. The attribute is checked by the list command, by the FHEMWEB room overview and by xmllist.
- sslVersion
  Specifies the accepted cryptography algorithms by all modules using the TcpServices helper module. The current default TLSv12:!SSLv3 is thought to be more secure than the previously used SSLv23:!SSLv3:!SSLv2, but it causes problems with some not updated web services.
- stacktrace
  if set (to 1), dump a stacktrace to the log for each "PERL WARNING".
- restartDelay
  set the delay for shutdown restart, default is 2 (seconds).

Events:

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

### ALL3076

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

### AMAD

AMAD - Automagic Android Device
This module integrates Android devices into FHEM and displays several settings using the Android app "Automagic". 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 can be displayed in FHEM by this module. Just define your own Automagic-"flow" 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 app and additional flows need to be installed on the Android device. The flows can be retrieved from the FHEM directory, the app can be bought in Google Play Store.
How to use AMAD?

- install the "Automagic Premium" app from the Google Play store.
- install the flowset 74_AMADautomagicFlowset$VERSION.xml from the directory $INSTALLFHEM/FHEM/lib/ on your Android device and activate.

Now you need to define a device in FHEM.
Define

`define <name> AMAD <IP-ADDRESS>`
Example:

`define WandTabletWohnzimmer AMAD 192.168.0.23`

With this command two new AMAD devices in a room called AMAD are created. The parameter <IP-ADDRESS< defines the IP address of your Android device. The second device created is the AMADCommBridge which serves as a communication device from each Android device to FHEM.
!!!Coming Soon!!! The communication port of each AMAD device may be set by the definition of the "port" attribute. One needs background knowledge of Automagic and HTTP requests as this port will be set in the HTTP request trigger of both flows, therefore the port also needs to be set there.
The communication port of the AMADCommBridge device can easily be changed within the attribut "port".

AMAD Communication Bridge

Creating your first AMAD device automatically creates the AMADCommBridge device in the room AMAD. With the help of the AMADCommBridge any Android device communicates initially to FHEM.To make the IP addresse of the FHEM server known to the Android device, the FHEM server IP address needs to be configured in the AMADCommBridge. WITHOUT THIS STEP THE AMADCommBridge WILL NOT WORK PROPERLY.
Please us the following command for configuration of the FHEM server IP address in the AMADCommBridge: set AMADCommBridge fhemServerIP <FHEM-IP>.
Additionally the expertMode may be configured. By this setting a direct communication with FHEM will be established without the restriction of needing to make use of a notify to execute set commands.

You are finished now! After 15 seconds latest the readings of your AMAD Android device should be updated. Consequently each 15 seconds a status request will be sent. If the state of your AMAD Android device does not change to "active" over a longer period of time one should take a look into the log file for error messages.
Readings

- airplanemode - on/off, state of the aeroplane mode
- androidVersion - currently installed version of Android
- automagicState - state of the Automagic App (prerequisite Android >4.3). In case you have Android >4.3 and the reading says "not supported", you need to enable Automagic inside Android / Settings / Sound & notification / Notification access
- batteryHealth - the health of the battery (1=unknown, 2=good, 3=overheat, 4=dead, 5=over voltage, 6=unspecified failure, 7=cold)
- batterytemperature - the temperature of the battery
- bluetooth - on/off, bluetooth state
- checkActiveTask - state of an app (needs to be defined beforehand). 0=not active or not active in foreground, 1=active in foreground, see note below
- connectedBTdevices - list of all devices connected via bluetooth
- connectedBTdevicesMAC - list of MAC addresses of all devices connected via bluetooth
- currentMusicAlbum - currently playing album of mediaplayer
- currentMusicApp - currently playing player app (Amazon Music, Google Play Music, Google Play Video, Spotify, YouTube, TuneIn Player, Aldi Life Music)
- currentMusicArtist - currently playing artist of mediaplayer
- currentMusicIcon - cover of currently play albumNoch nicht fertig implementiert
- currentMusicState - state of currently/last used mediaplayer
- currentMusicTrack - currently playing song title of mediaplayer
- daydream - on/off, daydream currently active
- deviceState - state of Android devices. unknown, online, offline.
- doNotDisturb - state of do not Disturb Mode
- dockingState - undocked/docked, Android device in docking station
- flow_SetCommands - active/inactive, state of SetCommands flow
- flow_informations - active/inactive, state of Informations flow
- flowsetVersionAtDevice - currently installed version of the flowsets on the Android device
- incomingCallerName - Callername from last Call
- incomingCallerNumber - Callernumber from last Call
- incommingWhatsAppMessageFrom - last WhatsApp message
- incommingWhatsTelegramMessageFrom - last telegram message
- intentRadioName - name of the most-recent streamed intent radio
- intentRadioState - state of intent radio player
- keyguardSet - 0/1 keyguard set, 0=no 1=yes, does not indicate whether it is currently active
- lastSetCommandError - last error message of a set command
- lastSetCommandState - last state of a set command, command send successful/command send unsuccessful
- lastStatusRequestError - last error message of a statusRequest command
- lastStatusRequestState - ast state of a statusRequest command, command send successful/command send unsuccessful
- nextAlarmDay - currently set day of alarm
- nextAlarmState - alert/done, current state of "Clock" stock-app
- nextAlarmTime - currently set time of alarm
- powerLevel - state of battery in %
- powerPlugged - 0=no/1,2=yes, power supply connected
- screen - on locked,unlocked/off locked,unlocked, state of display
- screenBrightness - 0-255, level of screen-brightness
- screenFullscreen - on/off, full screen mode
- screenOrientation - Landscape/Portrait, screen orientation (horizontal,vertical)
- screenOrientationMode - auto/manual, mode for screen orientation
- state - current state of AMAD device
- userFlowState - current state of a Flow, established under setUserFlowState Attribut
- volume - media volume setting
- volumeNotification - notification volume setting
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 notifications in status bar
- closeCall - hang up a running call
- currentFlowsetUpdate - start flowset update on Android device
- installFlowSource - install a Automagic flow on device, XML file must be stored in /tmp/ with extension xml. Example: set TabletWohnzimmer installFlowSource WlanUebwerwachen.xml
- doNotDisturb - sets the do not Disturb Mode, always Disturb, never Disturb, alarmClockOnly alarm Clock only, onlyImportant only important Disturbs
- mediaAmazonMusic - play/stop/next/back , controlling the amazon music media player
- mediaGoogleMusic - play/stop/next/back , controlling the google play music media player
- mediaSpotifyMusic - play/stop/next/back , controlling the spotify media player
- nextAlarmTime - sets the alarm time. Only valid for the next 24 hours.
- notifySndFile - plays a media-file which by default needs to be stored in the folder "/storage/emulated/0/Notifications/" of the Android device. You may use the attribute setNotifySndFilePath for defining a different folder.
- openCall - initial a call and hang up after optional time / set DEVICE openCall 0176354 10 call this number and hang up after 10s
- screenBrightness - 0-255, set screen brighness
- screenMsg - display message on screen of Android device
- sendintent - send intent string Example: set $AMADDEVICE sendIntent org.smblott.intentradio.PLAY url http://stream.klassikradio.de/live/mp3-192/stream.klassikradio.de/play.m3u name Klassikradio, first parameter contains the action, second parameter contains the extra. At most two extras can be used.
- sendSMS - Sends an SMS to a specific phone number. Bsp.: sendSMS Dies ist ein Test|555487263
- statusRequest - Get a new status report of Android device. Not all readings can be updated using a statusRequest as some readings are only updated if the value of the reading changes.
- timer - set a countdown timer in the "Clock" stock app. Only seconds are allowed as parameter.
- ttsMsg - send a message which will be played as voice message
- userFlowState - set Flow/s active or inactive,set Nexus7Wohnzimmer Badezimmer:inactive vorheizen or set Nexus7Wohnzimmer Badezimmer vorheizen,Nachtlicht Steven:inactive
- vibrate - vibrate Android device
- volume - set media volume. Works on internal speaker or, if connected, bluetooth speaker or speaker connected via stereo jack
- volumeNotification - set notifications volume

Set (depending on attribute values)

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

#### Define

`define <name> Alarm`
Defines the Alarm system.

#### Set

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

#### Get

- `get <name> version`
  Display the version of the module

#### Attributes

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

### ArduCounter

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

- This module requires an Arduino uno, nano, Jeenode or similar device running the ArduCounter sketch provided with this module

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 define if rising or falling edges of the signals should be counted. The optional keyword pullup activates the pullup resistor for the given Arduino Pin. The last argument is also optional and specifies a minimal pulse length in milliseconds. In this case the first argument (e.g. falling) means that an impulse starts with a falling edge from 1 to 0 and ends when the signal changes back from 0 to 1.
Example:

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

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 every falling edge of the signal (when the input changes from 1 to 0) is counted.
For D5 the arduino measures the time in milliseconds between the falling edge and the rising edge. If this time is longer than the specified 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.
For pin D6 the ardiono 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.

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

Readings / Events

The module creates at least the following readings and events for each defined pin:
- pin.*
the current count at this pin
- power.*
the current calculated power at this pin Most reading names can be customized with attribues and many more readings can be generated by setting the attribute verboseReadings[0-9]+ to 1.

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

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

Attributes

`attr <name> <attribute> <value>`
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

### CALVIEW

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

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

Define

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

`define myView CALVIEW Googlecalendar next`

`define myView CALVIEW Googlecalendar,holiday next 900`

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

Set

`set <Name> update`

`set myView update`

this will manually update all readings from the given CALENDAR Devices

Attribute
- datestyle
  not set - the default, disables displaying readings bdatetimeiso / edatetimeiso
  ISO8601 - enables readings bdatetimeiso / edatetimeiso (start and end time of term ISO8601 formated like 2017-02-27T00:00:00)
- disable
  0 / not set - internal notify function enabled (default)
  1 - disable the internal notify-function of CALVIEW wich is triggered when one of the given CALENDAR devices has updated
filterSummary
- filterSummary <filtersouce>:<filtersummary>[,<filtersouce>:<filtersummary>]
  not set - displays all terms (default .*:.*)
  <filtersouce>:<filtersummary>[,<filtersouce>:<filtersummary>] - CALVIEW will display term where summary matches the <filtersouce>:<filtersummary>, several filters must be separated by comma (,) e.g.: filterSummary Kalender_Abfall:Leichtverpackungen,Kalender_Abfall:Bioabfall filterSummary Kalender_Abfall:Leichtverpackungen,Kalender_Feiertage:.*,Kalender_Christian:.*,Kalender_Geburtstage:.*
- isbirthday
  0 / not set - no age calculation (default)
  1 - age calculation active. The module calculates the age with year given in description or location (see att yobfield).
- maxreadings
  defines the number of max term as readings
- modes
  here the CALENDAR modes can be selected , to be displayed in the view
- oldStyledReadings
  0 the default style of readings
  1 readings look like "2015.06.21-00:00" with value "Start of Summer"
- yobfield
  _description - (default) year of birth will be read from term description
  _location - year of birth will be read from term location
  _summary - year of birth will be read from summary (uses the first sequence of 4 digits in the string)

### CM11

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.
  - press <[short|long]> <[on|off|<peer>]> <btnNo>
    simulate a press of the local button or direct connected switch of the actor.
    [short|long] select simulation of short or long press of the button. Parameter is optional, short is default
    [on|off|<peer>] is relevant for devices with direct buttons per channel (blind or dimmer). Those are available for dimmer and blind-actor, usually not for switches
    <peer> allows to stimulate button-press of any peer of the actor. i.e. if the actor is peered to any remote, virtual or io (HMLAN/CUL) press can trigger the action defined.
    [noBurst] relevant for virtual only
    It will cause the command being added to the command queue of the peer. No burst is issued subsequent thus the command is pending until the peer wakes up. It therefore delays the button-press, but will cause less traffic and performance cost.
    Example: `set actor press # trigger short of internal peer self assotiated to the channel
    set actor press long # trigger long of internal peer self assotiated to the channel
    set actor press on # trigger short of internal peer self related to 'on'
    set actor press long off # trigger long of internal peer self related to 'of'
    set actor press long FB_Btn01 # trigger long peer FB button 01
    set actor press long FB_chn-8 # trigger long peer FB button 08
    set actor press self01 # trigger short of internal peer 01
    set actor press fhem02 # trigger short of FHEM channel 2
    `
  - pressL <peer>
    simulates a long press for a given peer. See press for details
  - pressS <peer>
    simulates a long press for a given peer. See press for details
  - toggle - toggle the Actor. It will switch from any current level to off or from off to 100%
- dimmer, blindActuator
  Dimmer may support virtual channels. Those are autocrated if applicable. Usually there are 2 virtual channels in addition to the primary channel. Virtual dimmer channels are inactive by default but can be used in in parallel to the primay channel to control light.
  Virtual channels have default naming SW<channel>_V<no>. e.g. Dimmer_SW1_V1 and Dimmer_SW1_V2.
  Dimmer virtual channels are completely different from FHEM virtual buttons and actors but are part of the HM device. Documentation and capabilities for virtual channels is out of scope.
  - 0 - 100 [on-time] [ramp-time]
    set the actuator to the given value (in percent) with a resolution of 0.5.
    Optional for dimmer on-time and ramp time can be choosen, both in seconds with 0.1s granularity.
    On-time is analog "on-for-timer".
    Ramp-time default is 2.5s, 0 means instantanous
  - on
  - off
  - press <[short|long]><[on|off]>
  - toggle
  - toggleDir - toggled drive direction between up/stop/down/stop
  - on-for-timer <sec> - Dimmer only!
  - on-till <time> - Dimmer only!
  - stop - stop motion (blind) or dim ramp
  - old - switch back to old value after a change. Dimmer only.
  - pct <level> [<ontime>] [<ramptime>] - set actor to a desired absolut level.
    Optional ontime and ramptime could be given for dimmer.
    ontime may be time in seconds. It may also be entered as end-time in format hh:mm:ss
  - up [changeValue] [<ontime>] [<ramptime>] dim up one step
  - down [changeValue] [<ontime>] [<ramptime>] dim up one step
    changeValue is optional an gives the level to be changed up or down in percent. Granularity is 0.5%, default is 10%.
    ontime is optional an gives the duration of the level to be kept. '0' means forever and is default.
    ramptime is optional an defines the change speed to reach the new level. It is meaningful only for dimmer.
- remotes, pushButton
  This class of devices does not react on requests unless they are put to learn mode. FHEM obeys this behavior by stacking all requests until learn mode is detected. Manual interaction of the user is necessary to activate learn mode. Whether commands are pending is reported on device level with parameter 'protCmdPend'.

- peerIODev [IO] <btn_no> [set|unset]
  The command is similar to peerChan. While peerChan is executed on a remote and peers any remote to any actor channel peerIODev is executed on an actor channel and peer this to an channel of an FHEM IO device.
  An IO device according to eQ3 supports up to 50 virtual buttons. Those will be peered/unpeerd to the actor. press can be used to stimulate the related actions as defined in the actor register.
- peerChan <btn_no> <actChan> [single|dual|reverse][set|unset] [both|actor|remote]
  peerChan will establish a connection between a sender- channel and an actuator-channel called link in HM nomenclatur. Peering must not be confused with pairing.
  Pairing refers to assign a device to the central.
  Peering refers to virtally connect two channels.
  Peering allowes direkt interaction between sender and aktor without the necessity of a CCU
  Peering a sender-channel causes the sender to expect an ack from -each- of its peers after sending a trigger. It will give positive feedback (e.g. LED green) only if all peers acknowledged.
  Peering an aktor-channel will setup a parameter set which defines the action to be taken once a trigger from -this- peer arrived. In other words an aktor will
  - process trigger from peers only
  - define the action to be taken dedicated for each peer's trigger
  An actor channel will setup a default action upon peering - which is actor dependant. It may also depend whether one or 2 buttons are peered in one command. A swich may setup oen button for 'on' and the other for 'off' if 2 button are peered. If only one button is peered the funktion will likely be 'toggle'.
  The funtion can be modified by programming the register (aktor dependant).
  Even though the command is executed on a remote or push-button it will as well take effect on the actuator directly. Both sides' peering is virtually independant and has different impact on sender and receiver side.
  Peering of one actuator-channel to multiple sender-channel as well as one sender-channel to multiple Actuator-channel is possible.
  <actChan> is the actuator-channel to be peered.
  <btn_no> is the sender-channel (button) to be peered. If 'single' is choosen buttons are counted from 1. For 'dual' btn_no is the number of the Button-pair to be used. I.e. '3' in dual is the 3rd button pair correcponding to button 5 and 6 in single mode.
  If the command is executed on a channel the btn_no is ignored. It needs to be set, should be 0
  [single|dual]: this mode impacts the default behavior of the Actuator upon using this button. E.g. a dimmer can be learned to a single button or to a button pair.
  Defaults to dual.
  'dual' (default) Button pairs two buttons to one actuator. With a dimmer this means one button for dim-up and one for dim-down.
  'reverse' identical to dual - but button order is reverse.
  'single' uses only one button of the sender. It is useful for e.g. for simple switch actuator to toggle on/off. Nevertheless also dimmer can be learned to only one button.
  [set|unset]: selects either enter a peering or remove it.
  Defaults to set.
  'set' will setup peering for the channels
  'unset' will remove the peering for the channels
  [actor|remote|both] limits the execution to only actor or only remote. This gives the user the option to redo the peering on the remote channel while the settings in the actor will not be removed.
  Defaults to both.
  Example:
  `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 HMLAN/USB is forced to request AES signature before sending ACK to the device.
  This funktion strictly works with HMLAN/USB - it doesn't work for CUL type IOs.
- actAutoTry actAutoTry 0_off,1_on
  setting this option enables Action Detector to send a statusrequest in case of a device is going to be marked dead. The attribut may be useful in case a device is being checked that does not send messages regularely - e.g. an ordinary switch.
- actCycle actCycle <[hhh:mm]|off>
  Supports 'alive' or better 'not alive' detection for devices. [hhh:mm] is the maximum silent time for the device. Upon no message received in this period an event will be raised "<device> is dead". If the device sends again another notification is posted "<device> is alive".
  This actiondetect will be autocreated for each device with build in cyclic status report.
  Controlling entity is a pseudo device "ActionDetector" with HMId "000000".
  Due to performance considerations the report latency is set to 600sec (10min). It can be controlled by the attribute "actCycle" of "ActionDetector".
  Once entered to the supervision the HM device has 2 attributes:
  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.
- IOgrp
  can be given to devices and shall point to a virtual CCU. As a consequence the CCU will take care of the assignment to the best suitable IO. It is necessary that a virtual CCU is defined and all relevant IO devices are assigned to it. Upon sending the CCU will check which IO is operational and has the best RSSI performance for this device.
  Optional a prefered IO - perfIO can be given. In case this IO is operational it will be selected regardless of rssi values.
  Example:
  `attr myDevice1 IOgrp vccu
  attr myDevice2 IOgrp vccu:prefIO
  attr myDevice2 IOgrp vccu:prefIO1,prefIO2,prefIO3
  `
- 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. When configured, the RFR device can be used like another CUL connected directly to fhem.
Before you can use this feature in fhem, you have to enable/configure RF ROUTING in both CUL's:

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

Define

`define <name> CUL_RFR <own-id> <base-id>`
<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:

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

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 (TCM97..., ABS700, TCM21...., Prologue, Rubicson, NC_WS, GT_WT_02, AURIOL, KW9010, Unknown)
- 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> <format> <filter> [<max>]`
Returns, line by line, information on the calendar events in the calendar <name>. The content depends on the <format> specifier:

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

The <filter> specifier determines the selected subset of calendar events:

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

The `mode=<regex>` and `uid=<regex>` filters should be preferred over the `<mode>` and `<uid>` filters.
The optional parameter `<max>` limits the number of returned lines.
See attributes `hideOlderThan` and `hideLaterThan` for how to return events within a certain time window. Please remember that the global ±400 days limits apply.
Examples:
`get MyCalendar text next`
`get MyCalendar summary uid:435kjhk435googlecom 1`
`get MyCalendar summary 435kjhk435googlecom 1`
`get MyCalendar full all`
`get MyCalendar text mode=alarm|start`
`get MyCalendar text uid=.*6286.*`
`get <name> find <regexp>`
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

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

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

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

- readingFnAttributes

Description

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

This is experimental. Use with caution.

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.

Usage scenarios

Show all calendar events with details

`get MyCalendar full all
2767324dsfretfvds7dsfn3e4dsa234r234sdfds6bh874googlecom alarm 31.05.2012 17:00:00 07.06.2012 16:30:00-07.06.2012 18:00:00 Erna for coffee
992hydf4y44awer5466lhfdsrgl7tin6b6mckf8glmhui4googlecom upcoming 08.06.2012 00:00:00-09.06.2012 00:00:00 Vacation`

Show calendar events in your photo frame

Put a line in the layout description to show calendar events in alarm or start mode:
`text 20 60 { fhem("get MyCalendar text next 2") }`
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.*
2767324dsfretfvds7dsfn3e4dsa234r234sdfds6bh874googlecom`
Then define a notify (the dot after the second colon matches the space):
`define ErnaComes notify MyCalendar:start:.2767324dsfretfvds7dsfn3e4dsa234r234sdfds6bh874googlecom set MyLight on`
You can also do some logging:
`define LogErna notify MyCalendar:alarm:.2767324dsfretfvds7dsfn3e4dsa234r234sdfds6bh874googlecom { 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 summary $uid");; if(defined $actor) { fhem("set $actor on") } }
define SwitchActorOff notify MyCalendar:end:.* { my $reading="$EVTPART0";; my $uid= "$EVTPART1";; my $actor= fhem("get MyCalendar summary $uid");; if(defined $actor) { fhem("set $actor off") } }`
You can also do some logging:
`define LogActors notify MyCalendar:(start|end):.* { my $reading= "$EVTPART0";; my $uid= "$EVTPART1";; my $actor= fhem("get MyCalendar summary $uid");; Log 3 $NAME, 1, "Actor: $actor, Reading $reading" }`

Embedded HTML

The module provides an additional function `CalendarAsHtml(<name>,<options>)`. It 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 ...`.
Example: `define MyCalendarWeblink weblink htmlCode { CalendarAsHtml("MyCalendar","next 3") }`
This is a rudimentary function which might be extended in a future version.

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

### 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:
`define <name> DOIF (<condition>) (<commands>) DOELSEIF (<condition>) (<commands>) DOELSEIF ... DOELSE (<commands>)`
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 overview and optionally DOIF
- check definitions and offer recommendations
- create shortcuts
- optionally create a menu entry
- show a list of running wait timer

Just one definition per FHEM-installation is allowed.

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

SX5 commands:

- 10minuteAlarm [on|off]
  Activates the alarm sound of the SX5 when the door is left open for longer than 10 minutes.
- 2000cycleAlarm [on|off]
  Activates the alarm sounds of the SX5 when the SX5 has run 2000 cycles.
- automaticClosing [off|30|60|90|120|150|180|210|240]
  Set the automatic closing time of the SX5 (sec).
- openSpeed [11|15|19]
  Set the open speed of the SX5 (cm/sec).
- backJump [on|off]
  If activated the SX5 moves briefly in the respective opposite direction after reaching the end point.
- getConfig
  Sends a config request message to the weather sensor.

Weather sensor commands:

- getConfig
  Sends a configuration request message.
- getTime
  Sends a time request message.
- getWeather
  Sends a weather data request message.
- writeConfig
  Write the configuration back to the weather sensor.
- DCF [on|off]
  Switch the DCF receiver on or off.
- time
  Set the current system time to the weather sensor.
- interval <value>
  Set the interval time for automatic transmittion of the weather data.
  <value>: off or 1 to 100 minutes
- latitude <value>
  Set the latitude of the weather sensor position
  <value>: 0 to 90
- longitude <value>
  Set the longitude of the weather sensor position
  <value>: -90 to 90
- timezone <value>
  Set the time zone of the weather sensor
  <value>: 0 to 23
- triggerDawn <value1> ... [<value5>]
  Sets up to 5 trigger values for a dawn event.
  <value[n]>: off or 1 to 100 lux
- triggerDusk <value1> ... [<value5>]
  Sets up to 5 trigger values for a dusk event.
  <value[n]>: off or 1 to 100 Lux
- triggerRain [on|off]
  Switch the trigger of the rain event on or off.
- triggerSun <value1>:<sun1>:<shadow1>[:<temperature1>] ... [<value5>:<sun5>:<shadow5>[:<temperature5>]]
  Sets up to 5 trigger values for a sun event.
  <value[n]>: off or 1 to 100 kLux
  <sun[n]>: time to detect sun, 1 to 30 minutes
  <shadow[n]>: time to detect shadow, 1 to 30 minutes
  <temperature[n]>: optional minimum temperature, -5 to 26 °C
- triggerSunDirction <startangle1>:<width1> ... [<startangle5>:<width5>]
  If enabled, the respective sun event will only be triggered, if sunDirection is in the specified range.
  <startangle[n]>: off or 0 to 292.5 degrees (stepsize 22.5°)
  <width[n]>: 45 to 180 degrees (stepsize 45°)
- triggerSunHeight <startangle1>:<width1> ... [<startangle5>:<width5>]
  If enabled, the respective sun event will only be triggered, if sunHeight is in the specified range.
  <startangle[n]>: off or 0 to 65 degrees (stepsize 13°)
  <width[n]>: 26 or 52 degrees
- triggerTemperature <value1> ... [<value5>]
  Sets up to 5 trigger values for a temperature event.
  <value[n]>: off or -40 to 80 °C
- triggerWind <value1> ... [<value5>]
  Sets up to 5 trigger values for a wind event.
  <value[n]>: off or 1 to 31 m/s

Get

N/A

Attributes

- IODev
- timeout <sec>
  After sending a command to an actor, the actor must respond with its status within this time. If no status message is received, up to two getStatus commands are resend.
  Default 60s.
- toggleUpDown
  If attribute is set, a stop command is send instead of the up or down command if the roller shutter is moving.

### DUOFERNSTICK

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

### 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_colcount>
- dashboard_tabXbackgroundimage
  Shows a background image for the X tab. The image is not stretched in any way, it should therefore match the tab size or extend it. Standard:
- dashboard_flexible
  If set to a value > 0, the widgets are not positioned in columns any more but can be moved freely to any position in the tab.
  The value for this parameter also defines the grid, in which the position "snaps in". Default: 0
- dashboard_showfullsize
  Hide FHEMWEB Roomliste (complete left side) and Page Header if Value is 1.
  Default: 0
- dashboard_showtabs
  Displays the Tabs/Buttonbar on top or bottom, or hides them. If the Buttonbar is hidden lockstate is "lock" is used.
  Default: tabs-and-buttonbar-at-the-top
- dashboard_showtogglebuttons
  Displays a Toogle Button on each Group do collapse.
  Default: 0
- dashboard_backgroundimage
  Displays a background image for the complete dashboard. The image is not stretched in any way so the size should match/extend the dashboard height/width. Default:
- dashboard_debug
  Show Hiddenfields. Only for Maintainer's use.
  Default: 0

### DbLog

Define

`define <name> DbLog <configfilename> <regexp>`
Log events to a database. The database connection is defined in `<configfilename>` (see sample configuration file `contrib/dblog/db.conf`). 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.
DbLog distinguishes between the synchronous (default) and asynchronous logmode. The logmode is adjustable by the attribute asyncMode.
The modules `DBI` and `DBD::<dbtype>` need to be installed (use `cpan -i <module>` if your distribution does not have it).
`<regexp>` is the same as in FileLog.
Sample code to create a MySQL/PostgreSQL/SQLite database is in `<DBType>_create.sql`. 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. (see also attribute DbLogType) The columns have the following meaning:

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

The content of VALUE is optimized for automated post-processing, e.g. `yes` is translated to `1`
The current values can be retrieved by the following code like FileLog:

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

Examples:

`# log everything to database`
`define myDbLog DbLog /etc/fhem/db.conf .*:.*`

Set

`set <name> 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> 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> 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> count`

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

`set <name> deleteOldDays <n>`

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

`set <name> 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=deviceRegExp1:ReadingRegExp1,deviceRegExp2:ReadingRegExp2,...]`

Reduce records older than <n> days to one record each hour (the 1st) per device & reading.
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 completely blocked after issuing the command to completion!
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=deviceRegExp1:ReadingRegExp1,deviceRegExp2:ReadingRegExp2,...." to exclude device/readings from reduceLog
You can optional set the last argument to "INCLUDE=Database-deviceRegExp:Database-ReadingRegExp" to delimit the SELECT statement which is executet on the database. This reduce the system RAM load and increase the performance. (Wildcards are % and _)

`set <name> userCommand <validSqlStatement>`

DO NOT USE THIS COMMAND UNLESS YOU REALLY (REALLY!) KNOW WHAT YOU ARE DOING!!!
Perform any (!!!) sql statement on connected database. Useercommand and result will be written into corresponding readings.

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

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

cacheEvents

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

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

cacheLimit

`attr <device> cacheLimit <n>`
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".

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 table history will be used as default.
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
- 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 <device1>,<device2>,<device..>`
The devices "device1", "device2" up to "device.." will be excluded from logging into database. This attribute will only be evaluated if in DbLog-define ".*:.." (that means all devices should be logged) is set. Thereby devices can be excluded explicitly instead of include all relevant devices (devices want to log into database) in the DbLog-define (e.g. by string (device1|device2|device..):.* and so on). The devices to exclude are evaluated as Regex.
Example
`attr <device> excludeDevs global,Log.*,Cam.*`
# The devices global respectively devices starting with "Log" or "Cam" are excluded from database logging.

noNotifyDev

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

syncEvents

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

shutdownWait

`attr <device> shutdownWait <n>`
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 used total time 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.

suppressUndef

`attr <device> ignoreUndef <n>`
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 <n>`
setup timeout of the write cycle into database in asynchronous mode (default 120s)

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.
All database operations are implemented nonblocking. 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.
- Selecion of datasets by usage of dynamically calclated time limits at execution time.
- Calculation of quantity of datasets of a Device/Reading-combination within adjustable time limits and several aggregations.
- The calculation of summary- , difference- , maximum- , minimum- and averageValues of numeric readings within adjustable time limits and several aggregations.
- The deletion of datasets. The containment of deletion can be done by Device and/or Reading as well as fix or dynamically calculated time limits at execution time.
- export of datasets to file (CSV-format).
- import of datasets from file (CSV-Format).
- rename of device names in datasets
- automatic rename of device names in datasets and other DbRep-definitions after FHEM "rename" command (see DbRep-Agent)

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 .
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. (currently tested with MySQL and SQLite).
Only the content of table "history" will be included.
Overview which other Perl-modules DbRep is using:
POSIX
Time::HiRes
Time::Local
Scalar::Util
DBI
Blocking (FHEM-module)
Due to performance reason the following index should be created in addition:
`ALTER TABLE 'fhem'.'history' ADD INDEX `Reading_Time_Idx` (`READING`, `TIMESTAMP`) 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 - calculates the average value of readingvalues DB-column "VALUE") between period given by timestamp-attributes which are set. The reading to evaluate must be defined using attribute "reading".
- countEntries - provides the number of DB-entries between period given by timestamp-attributes which are set. If timestamp-attributes are not set, all entries in db will be count. The attributes "device" and "reading" can be used to limit the evaluation.
- 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.
  input format: 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.

- 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.
  input format: 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.

- exportToFile - exports DB-entries to a file in CSV-format between period given by timestamp. Limitations of selections can be set by attributes Device and/or Reading. The filename will be defined by attribute "expimpfile" .
- fetchrows - provides all DB-entries between period given by timestamp-attributes. An aggregation which would possibly be set attribute will not considered.
- insert - use it to insert data ito table "history" manually. Input values for Date, Time and Value are mandatory. The database fields for Type and Event will be filled in with "manual" automatically and the values of Device, Reading will be get from set attributes.
  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
  # field length is maximum 32 (MYSQL) / 64 (POSTGRESQL) characters long, 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 - imports datasets in CSV format from file into database. The filename will be set by attribute "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: "2016-09-25 08:53:56","STP_5000","SMAUTILS","etotal: 11859.573","etotal","11859.573",""
- sumValue - calculates the amount of readingvalues DB-column "VALUE") between period given by attributes "timestamp_begin", "timestamp_end" or "timeDiffToNow / timeOlderThan". The reading to evaluate must be defined using attribute "reading". Using this function is mostly reasonable if value-differences of readings are written to the database.
- maxValue - calculates the maximum value of readingvalues DB-column "VALUE") between period given by attributes "timestamp_begin", "timestamp_end" or "timeDiffToNow / timeOlderThan". The reading to evaluate must be defined using attribute "reading". The evaluation contains the timestamp of the last appearing of the identified maximum value within the given period.
- minValue - calculates the miniimum value of readingvalues DB-column "VALUE") between period given by attributes "timestamp_begin", "timestamp_end" or "timeDiffToNow / timeOlderThan". The reading to evaluate must be defined using attribute "reading". The evaluation contains the timestamp of the first appearing of the identified minimum value within the given period.
- diffValue - calculates the defference of the readingvalues DB-column "VALUE") between period given by attributes "timestamp_begin", "timestamp_end" or "timeDiffToNow / timeOlderThan". The reading to evaluate must be defined using attribute "reading". This function is mostly reasonable if readingvalues are increasing permanently and don't write value-differences to the database. The difference will be generated from the first available dataset (VALUE-Field) to the last available dataset between the specified time linits/aggregation, in which a balanced difference value of the previous aggregation period will be transfered to the following aggregation period in case this period contains a value.
  An possible counter overrun (restart with value "0") will be considered (compare attribute "diffAccept").
  If only one dataset will be found within the evalution period, the difference can be calculated only in combination with the balanced difference of the previous aggregation period. In this case a logical inaccuracy according the assignment of the difference to the particular aggregation period can be possible. Hence in warning in "state" will be placed and the reading "less_data_in_period" with a list of periods with only one dataset found in it will be created.
  no difference can be calculated and the reading "less_data_in_period" with a list of concerned periods will be generated in that case.
  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.
- 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
  Due to security reasons the attribute "allowDeletion" needs to be set to unlock the delete-function.
For all evaluation variants applies:
In addition to the needed reading the device can be complemented to restrict the datasets for reporting / function. If the time limit attributes are not set, the period from '1970-01-01 01:00:00' to the current date/time will be used as selection 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-Wildcards (% _) 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 !

- 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

- 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

- 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 schema. The analyzed schematics are depend on the rights of the used database user (default: the database schema of tables current,history). Using theattribute "showTableInfo" the results can be limited. 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" will be created
Attributes

Using the module specific attributes you are able to define the scope of evaluation and the aggregation.
Hint to SQL-Wildcard Usage:
Within the attribute values of "device" and "reading" you may use SQL-Wildcards, "%" and "_". The character "%" stands for any some characters, but the character "_" = stands for only one.
This rule is valid to all functions except "insert", "deviceRename" and "delEntries".
The function "insert" doesn't allow setting the mentioned attributes containing the wildcard "%", the character "_" will evaluated as a normal character.
The deletion function "delEntries" evaluates both characters "$", "_" NOT as wildcards and delete device/readings only if they are entered in the attribute as exactly as they are stored in the database . 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
- device - selection of a particular device
- diffAccept - valid for function diffValue. diffAccept determines the threshold, up to that a calaculated difference between two straight sequently datasets should be commenly accepted (default = 20).
  Hence faulty DB entries with a disproportional high difference value will be eliminated and don't tamper the result. If a threshold overrun happens, the reading "diff_overrun_limit_<diffLimit>" will be generated (<diffLimit> will be substituted with the present prest attribute value).
  The reading contains a list of relevant pair of values. Using verbose=3 this list will also be reported in the FHEM logfile.

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
- expimpfile - Path/filename for data export/import
- reading - selection of a particular reading
- readingNameMap - the name of the analyzed reading can be overwritten for output
- role - the role of the DbRep-device. Standard role is "Client". The role "Agent" is described in section DbRep-Agent.
- readingPreventFromDel - comma separated list of readings which are should prevent from deletion when a new operation starts
- showproctime - if set, the reading "sql_processing_time" shows the required execution time (in seconds) for the sql-requests. This is not calculated for a single sql-statement, but the summary of all sql-statements necessara for within an executed DbRep-function in background.
- showStatus - limits the sample space of command "get ... dbstatus". SQL-Wildcards (% _) can be used.

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

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

Example: attr ... 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 ... svrinfo". SQL-Wildcards (% _) can be used.

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

- showTableInfo - limits the sample space of command "get ... tableinfo". SQL-Wildcards (% _) can be used.

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

- timestamp_begin - begin of data selection (*)
- timestamp_end - end of data selection. If not set the current date/time combination will be used. (*)
- timeDiffToNow - the begin of data selection will be set to the timestamp "<current time> - <timeDiffToNow>" dynamically (in seconds). Thereby always the last <timeDiffToNow>-seconds will be considered (e.g. if set to 86400, always the last 24 hours should assumed). The Timestamp calculation will be done dynamically at execution time.
- timeOlderThan - the end of data selection will be set to the timestamp "<aktuelle Zeit> - <timeOlderThan>" dynamically (in seconds). Always the datasets up to timestamp "<current time> - <timeOlderThan>" will be considered (e.g. if set to 86400, all datasets older than one day will be considered). The Timestamp calculation will be done dynamically at execution time.
- timeout - sets the timeout-value for Blocking-Call Routines in background (default 60 seconds)

(*) 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:

current_year_begin : set the timestamp-attribute to "<current year>-01-01 00:00:00" dynamically
current_year_end : set the timestamp-attribute to "<current year>-12-31 23:59:59" dynamically
previous_year_begin : set the timestamp-attribute to "<previous year>-01-01 00:00:00" dynamically
previous_year_end : set the timestamp-attribute to "<previous year>-12-31 23:59:59" dynamically

Make sure that timestamp_begin < timestamp_end is fulfilled.
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.

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

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 to 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 3600
`

### 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.
- setList
  Space separated list of commands, which will be returned upon "set name ?", so the FHEMWEB frontend can construct the correct control and command dropdown. Specific controls can be added after a colon for each command
- additionalPosReading
  Position of the shutter will be stored in the reading `pos` as numeric value. Additionally this attribute might specify a name for an additional reading to be updated with the same value than the pos.
- eventMap
  Replace event names and set arguments. The value of this attribute consists of a list of space separated values, each value is a colon separated pair. The first part specifies the "old" value, the second the new/desired value. If the first character is slash(/) or comma(,) then split not by space but by this character, enabling to embed spaces. Examples:
  `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.
- 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

- loglevel
- readingFnAttributes

Generated events

- EGPM <name> <[on|off]>

### EGPM2LAN

Define

`define <name> EGPM2LAN <IP-Address> [<Password>]`
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.
EG-PMS2-LAN with surge protector feature was not tested until now.

Set

`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

N/A

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 SecretGarden`
`set mainswitch on 1`

### EIB / KNX

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

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

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

Define

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

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

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

For actors and sensors the autocreate module may help.

Example:

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

Set

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

where value one of:

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

Example:

          set lamp1 on
          set lamp1 off
          set lamp1 on-for-timer 10
          set lamp1 on-till 13:15:00
          set lamp1 raw 234578
          set lamp1 value 23.44

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

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

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

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

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

          define timedev EIB 0/0/7
          attr timedev model time
          attr timedev eventMap /value now:now/
          attr timedev webCmd now

          define datedev EIB 0/0/8
          attr datedev model date
          attr datedev eventMap /value now:now/
          attr datedev webCmd now

          # send every midnight the new date
          define dateset at *00:00:00 set datedev value now

          # send every hour the current time
          define timeset at +*01:00:00 set timedev value now

Get

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

Attributes

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

EIBreadingX

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

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

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

Example:

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

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

EIBreadingSender

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

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

    sender

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

Example:

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

EIBanswerReading

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

If set to 1, read-requests are answered

Example:

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

EIBreadingRegex

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

Example:

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

EIBwritingRegex

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

Example:

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

model

This attribute is mandatory!

Set the model according to the datapoint types defined by the (EIB / KNX specifications). The device state in FHEM is interpreted and shown according to the specification.
dpt1 - 1 bit
Will be interpreted as on/off, 1=on 0=off and vice versa
dpt3 - Discrete Dim-Message
Usage: set value to +/-0..100. -54 means dim down by 50%
dpt5 - 1 byte unsigned
dpt5.003 - angle in degrees
angle - same as dpt5.003
dpt5.004 - percent
percent - same as above
percent255 - scaled percentage: 255=100%
dpt6 - 1 byte signed
dpt6.001 - percent
dpt6.010
dpt7 - 2 byte unsigned
length - mm
current - mA
brightness
timeperiod - ms
timeperiod - min
timeperiod - h
dpt9 - 2 byte float
tempsensor
lightsensor
speedsensor
speedsensor-km/h
pressuresensor
rainsensor
time1sensor
time2sensor
humiditysensor
airqualitysensor
voltage-mV
current-mA2
current-mA2
power
powerdensity
dpt10 - time hh:mm:ss
dpt10_ns - same as DPT10, seconds always 0
time - receiving has no effect, sending any value contains actual system time. For examle use set timedev value now
dpt11 - date dd.mm.yyyy
date - receiving has no effect, sending any value contains actual system date. For examle use set timedev value now
dpt12 - 4 byte unsigned
dpt13 - 4 byte signed
dpt14 - 4 byte float
dpt16 - text, use with "string": set textdev string Hallo Welt

### EM

Define

`define <name> EM <em1010pc-device>`
Define 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`

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

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

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

### 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.
<ber> 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 <name> 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 <name> 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 <device> model OEM and attr <device> 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 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 FSB14|FSB61|FSB70|TF manually.
  Use the sensor type "Szenentaster/PC" for Eltako devices.
- Electronic switches and dimmers with Energy Measurement and Local Control (D2-01-00 - D2-01-12)
  [Telefunken Funktionsstecker, PEHA Easyclick, AWAG Elektrotechnik AG Omnio UPS 230/xx,UPD 230/xx, NodOn in-wall module, smart plug]
  `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/m2|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 FT55|FSM12|FSM61|FTS12 or attr sensorMode to pushbutton manually.
- Pushbutton Switch (EEP F6-3F-7F)
  [Eltako FGW14/FAM14 with internal decryption and RS-485 communication]
  - A0
  - AI
  - B0
  - BI
  - C0
  - CI
  - D0
  - DI
  - <BtnX,BtnY> First and second action where BtnX and BtnY is one of the above, e.g. A0,BI or D0,CI
  - released
  - buttons: pressed|released
  - state: <BtnX>[,<BtnY>] [released]
  Set attr subType to switch.7F and manufID to 00D.
  The status of the device may become "released", this is not the case for a normal switch. Set attr sensorMode to pushbutton manually.
- Pushbutton Switch (EEP D2-03-00)
  [EnOcean PTM 215 Modul]
  - A0
  - AI
  - B0
  - BI
  - <BtnX,BtnY> First and second action where BtnX and BtnY is one of the above, e.g. A0,BI
  - pressed
  - released
  - teach: <result of teach procedure>
  - energyBow: pressed|released
  - state: <BtnX>|<BtnX>,<BtnY>|released|pressed|teachIn|teachOut
  The attr subType must be switch.00. This is done if the device was created by autocreate. Set attr sensorMode to pushbutton manually if needed.
- Heating/Cooling Relay (EEP F6-02-01 ... F6-02-02)
  [Eltako FAE14, FHK14, untested]
  - controllerMode: auto|off
  - energyHoldOff: normal|holdoff
  - buttons: pressed|released
  Set attr subType to switch and model to FAE14|FHK14 manually. In addition every telegram received from a teached-in temperature sensor (e.g. FTR55H) is repeated as a confirmation telegram from the Heating/Cooling Relay FAE14, FHK14. In this case set attr subType to e. g. roomSensorControl.05 and attr manufID to 00D.
- Key Card Activated Switch (EEP F6-04-01)
  [Eltako FKC, FKF, FZS, untested]
  - keycard_inserted
  - keycard_removed
  - state: keycard_inserted|keycard_removed
  Set attr subType to keycard manually.
- Wind Speed Threshold Detector (EEP F6-05-00)
  - on
  - off
  - alarm: dead_sensor|off
  - windSpeed: dead_sensor|on|off
  - battery: low|ok
  - state: on|off
  Set attr subType to windSpeed.00 manually.
- Liquid Leakage Sensor (EEP F6-05-01)
  [untested]
  - dry
  - wet
  - state: dry|wet
  Set attr subType to liquidLeakage manually.
- Smoke Detector (EEP F6-05-02)
  [Eltako FRW]
  - smoke-alarm
  - off
  - alarm: dead_sensor|smoke-alarm|off
  - battery: low|ok
  - state: smoke-alarm|off
  Set attr subType to smokeDetector.02 manually.
- Window Handle (EEP F6-10-00, D2-03-10)
  [HOPPE SecuSignal, Eltako FHF, Eltako FTKE]
  - closed
  - open
  - tilted
  - open_from_tilted
  - state: closed|open|tilted|open_from_tilted
  The device windowHandle or windowHandle.10 should be created by autocreate.
- Single Input Contact, Door/Window Contact
  1BS Telegram (EEP D5-00-01)
  [EnOcean STM 320, STM 329, STM 250, Eltako FTK, Peha D 450 FU]
  - closed
  - open
  - teach: <result of teach procedure>
  - state: open|closed
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: <location0 ... location9> 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: <location0 ... location9> B: full|ok|low|empty
  The attr subType must be autoMeterReading.05. This is done if the device was created by autocreate.
- Automated meter reading (AMR), Current Meter 16 Channels (EEP A5-12-10)
  [untested]
  - I/mA
  - current<00 ... 15>: I/mA (Sensor Range: I = 0 mA ... 16777215 mA)
  - electricChange<00 ... 15>: Q/Ah (Sensor Range: Q = 0 Ah ... 16777215 Ah)
  - currentTariff: 00 ... 15
  - state: I/mA
  The attr subType must be autoMeterReading.10. This is done if the device was created by autocreate.
- Environmental Applications
  Weather Station (EEP A5-13-01)
  Sun Intensity (EEP A5-13-02)
  [Eltako FWS61]
  - T: t/°C B: E/lx W: Vs/m IR: yes|no
  - brightness: E/lx (Sensor Range: E = 0 lx ... 999 lx)
  - dayNight: day|night
  - hemisphere: north|south
  - isRaining: yes|no
  - sunEast: E/lx (Sensor Range: E = 1 lx ... 150 klx)
  - sunSouth: E/lx (Sensor Range: E = 1 lx ... 150 klx)
  - sunWest: E/lx (Sensor Range: E = 1 lx ... 150 klx)
  - temperature: t/°C (Sensor Range: t = -40 °C ... 80 °C)
  - windSpeed: Vs/m (Sensor Range: V = 0 m/s ... 70 m/s)
  - state:T: t/°C B: E/lx W: Vs/m IR: yes|no
  Brightness is the strength of the dawn light. SunEast, sunSouth and sunWest are the solar radiation from the respective compass direction. IsRaining is the rain indicator.
  The attr subType must be environmentApp and attr manufID must be 00D for Eltako Devices. This is done if the device was created by autocreate.
  The Eltako Weather Station FWS61 supports not the day/night indicator (dayNight).
- Environmental Applications
  Data Exchange (EEP A5-13-03)
  Time and Day Exchange (EEP A5-13-04)
  Direction Exchange (EEP A5-13-05)
  Geographic Exchange (EEP A5-13-06)
  - azimuth: α/° (Sensor Range: α = 0 ° ... 359 °)
  - date: JJJJ-MM-DD
  - elevation: β/° (Sensor Range: β = -90 ° ... 90 °)
  - latitude: φ/° (Sensor Range: φ = -90 ° ... 90 °)
  - longitude: λ/° (Sensor Range: λ = -180 ° ... 180 °)
  - time: hh:mm:ss [AM|PM]
  - timeSource: GPS|RTC
  - weekday: Monday|Tuesday|Wednesday|Thursday|Friday|Saturday|Sunday
  The attr subType must be environmentApp. This is done if the device was created by autocreate.
- Environmental Applications
  Sun Position and Radiation (EEP A5-13-10)
  [untested]
  - SRA: E m2/W SNA: α/° SNE: β/°
  - dayNight: day|night
  - solarRadiation: E m2/W (Sensor Range: E = 0 W/m2 ... 2000 W/m2)
  - sunAzimuth: α/° (Sensor Range: α = -90 ° ... 90 °)
  - sunElevation: β/° (Sensor Range: β = 0 ° ... 90 °)
  - state:SRA: E m2/W SNA: α/° SNE: β/°
  The attr subType must be environmentApp. This is done if the device was created by autocreate.
- Wind Sensor (EEP A5-13-07)
  [Hideki, untested]
  - Vh/km (Sensor Range: V = 0 km/h ... 199.9 km/h)
  - battery: ok|low
  - windSpeedAverage: Vh/km (Sensor Range: V = 0 km/h ... 199.9 km/h)
  - windSpeedDirection: NNE|NE|ENE|E|ESE|SE|SSE|S|SSW|SW|WSW|W|WNW|NW|NNW|N
  - windSpeedMax: Vh/km (Sensor Range: V = 0 km/h ... 199.9 km/h)
  - state:Vh/km (Sensor Range: V = 0 km/h ... 199.9 km/h)
  The attr subType must be windSensor.01. This is done if the device was created by autocreate.
- Rain Sensor (EEP A5-13-08)
  [Hideki, untested]
  - H/mm
  - battery: ok|low
  - rain: H/mm
  - state:H/mm
  The amount of rainfall is calculated at intervals of 183 s.
  The attr subType must be rainSensor.01. This is done if the device was created by autocreate.
- Multi-Func Sensor (EEP A5-14-01 ... A5-14-06)
  [untested]
  - C: open|closed V: on|off E: E/lx U: U/V
  - brightness: E/lx (Sensor Range: E = 0 lx ... 1000 lx, over range)
  - contact: open|closed
  - errorCode: 251 ... 255
  - vibration: on|off
  - voltage: U/V (Sensor Range: U = 0 V ... 5.0 V)
  - state: C: open|closed V: on|off E: E/lx U: U/V
  The attr subType must be multiFuncSensor. This is done if the device was created by autocreate.
- Dual Door Contact (EEP A5-14-07, A5-14-08)
  [untested]
  - C: open|closed B: unlocked|locked V: on|off U: U/V
  - alarm: dead_sensor
  - block: unlocked|locked
  - contact: open|closed
  - vibration: on|off
  - voltage: U/V (Sensor Range: U = 0 V ... 5.0 V)
  - state: C: open|closed B: unlocked|locked V: on|off U: U/V
  The attr subType must be doorContact. This is done if the device was created by autocreate.
- Window/Door Contact (EEP A5-14-09, A5-14-0A)
  [untested]
  - W: open|tilt|closed B: unlocked|locked V: on|off U: U/V
  - alarm: dead_sensor
  - vibration: on|off
  - voltage: U/V (Sensor Range: U = 0 V ... 5.0 V)
  - window: open|tilt|closed
  - state: W: open|tilt|closed V: on|off U: U/V
  The attr subType must be windowContact. This is done if the device was created by autocreate.
- Battery Powered Actuator (EEP A5-20-01)
  [Kieback&Peter MD15-FTL-xx]
  - T: t/°C SPT: t/°C SP: setpoint/%
  - actuatorState: obstructed|ok
  - alarm: no_response_from_actuator
  - battery: ok|low
  - cover: open|closed
  - delta: <floating-point number>
  - energyInput: enabled|disabled
  - energyStorage: charged|empty
  - maintenanceMode: off|runInit|valveClosed|valveOpend:runInit
  - operationMode: off|setpoint|setpointTemp
  - p_d: <floating-point number>
  - p_i: <floating-point number>
  - p_p: <floating-point number>
  - pidAlarm: actuator_in_errorPos|dead_sensor|no_temperature_value|setpoint_device_missing
  - pidState: alarm|idle|processing|start|stop|
  - roomTemp: t/°C
  - selfCtl: on|off
  - setpoint: setpoint/%
  - setpointSet: setpoint/%
  - setpointCalc: setpoint/%
  - setpointTemp: t/°C
  - setpointTempSet: t/°C
  - teach: <result of teach procedure>
  - temperature: t/°C
  - waitingCmds: no_change|runInit|setpoint|setpointTemp|valveCloses|valveOpens
  - wakeUpCycle: t/s
  - window: open|closed
  - state: T: t/°C SPT: t/°C SP: setpoint/%
  The internal temperature sensor (roomTemp) of the Micropelt iTRV is not suitable as a room thermostat.
  The attr subType must be hvac.01. This is done if the device was created by autocreate.
- Heating Radiator Actuating Drive (EEP A5-20-04)
  [Holter SmartDrive MX]
  - T: t/°C SPT: t/°C SP: setpoint/%
  - alarm: measurement_error|battery_empty|frost_protection|blocked_valve|end_point_detection_error|no_valve|not_taught_in|no_response_from_controller|teach-in_error
  - battery: ok|empty
  - blockKey: yes|no
  - delta: <floating-point number>
  - feedTemp: t/°C
  - maintenanceMode: off|runInit|valveClosed|valveOpend:runInit
  - measurementState: active|inactive
  - operationMode: off|setpoint|setpointTemp
  - p_d: <floating-point number>
  - p_i: <floating-point number>
  - p_p: <floating-point number>
  - pidAlarm: actuator_in_errorPos|dead_sensor|no_temperature_value|setpoint_device_missing
  - pidState: alarm|idle|processing|start|stop|
  - roomTemp: t/°C
  - setpoint: setpoint/%
  - setpointSet: setpoint/%
  - setpointCalc: setpoint/%
  - setpointTemp: t/°C
  - setpointTempSet: t/°C
  - teach: <result of teach procedure>
  - temperature: t/°C
  - waitingCmds: no_change|runInit|setpoint|setpointTemp|valveCloses|valveOpens
  - state: T: t/°C SPT: t/°C SP: setpoint/%
  The attr subType must be hvac.04. This is done if the device was created by autocreate.
- Generic HVAC Interface (EEP A5-20-10)
  [IntesisBox PA-AC-ENO-1i]
  - on|off
  - ctrl: auto|0...100
  - fanSpeed: auto|1...14
  - occupancy: occupied|off|standby|unoccupied
  - mode: auto|heat|morning_warmup|cool|night_purge|precool|off|test|emergency_heat|fan_only|free_cool|ice|max_heat|eco|dehumidification|calibration|emergency_cool|emergency_stream|max_cool|hvc_load|no_load|auto_heat|auto_cool
  - vanePosition: auto|horizontal|position_2|position_3|position_4|vertical|swing|vertical_swing|horizontal_swing|hor_vert_swing|stop_swing
  - powerSwitch: on|off
  - teach: <result of teach procedure>
  - state: on|off
  The attr subType must be hvac.10. This is done if the device was created by autocreate.
- Generic HVAC Interface - Error Control (EEP A5-20-11)
  [IntesisBox PA-AC-ENO-1i]
  - error|ok
  - alarm: error|ok
  - errorCode: 0...65535
  - externalDisable: disable|enable
  - keyCardDisable: disable|enable
  - otherDisable: disable|enable
  - powerSwitch: on|off
  - remoteCtrl: disable|enable
  - teach: <result of teach procedure>
  - window: closed|opened
  - windowDisable: disable|enable
  - state: error|ok
  The attr subType must be hvac.11. This is done if the device was created by autocreate.
- Digital Input (EEP A5-30-01, A5-30-02)
  [Thermokon SR65 DI, untested]
  - open|closed
  - battery: ok|low (only EEP A5-30-01)
  - contact: open|closed
  - teach: <result of teach procedure>
  - state: open|closed
  The attr subType must be digitalInput.01 or digitalInput.02. This is done if the device was created by autocreate.
- Digital Input (EEP A5-30-03)
  4 digital Inputs, Wake, Temperature [untested]
  - T: t/°C I: 0|1 0|1 0|1 0|1 W: 0|1
  - in0: 0|1
  - in1: 0|1
  - in2: 0|1
  - in3: 0|1
  - teach: <result of teach procedure>
  - temperature: t/°C (Sensor Range: t = 0 °C ... 40 °C)
  - wake: high|low
  - state: T: t/°C I: 0|1 0|1 0|1 0|1 W: high|low
  The attr subType must be digitalInput.03. This is done if the device was created by autocreate.
- Digital Input (EEP A5-30-04)
  3 digital Inputs, 1 digital Input 8 bits [untested]
  - 0|1 0|1 0|1 0...255
  - in0: 0|1
  - in1: 0|1
  - in2: 0|1
  - in3: 0...255
  - teach: <result of teach procedure>
  - state: 0|1 0|1 0|1 0...255
  The attr subType must be digitalInput.04. This is done if the device was created by autocreate.
- Digital Input, single input contact, retransmission, battery monitor (EEP A5-30-05)
  [untested]
  - error|event|heartbeat
  - battery: U/V (Range: U = 0 V ... 3.3 V
  - signalIdx: 0 ... 127
  - teach: <result of teach procedure>
  - telegramType: event|heartbeat
  - state: error|event|heartbeat
  The attr subType must be digitalInput.05. This is done if the device was created by autocreate.
- Energy management, demand response (EEP A5-37-01)
  - on|off|waiting_for_start|waiting_for_stop
  - level: 0...15
  - powerUsage: powerUsage/%
  - powerUsageLevel: max|min
  - powerUsageScale: rel|max
  - randomEnd: yes|no
  - randomStart: yes|no
  - setpoint: 0...255
  - teach: <result of teach procedure>
  - timeout: yyyy-mm-dd hh:mm:ss
  - state: on|off|waiting_for_start|waiting_for_stop
  The attr subType must be energyManagement.01. This is done if the device was created by autocreate.
- Gateway (EEP A5-38-08)
  Switching
  [Eltako FLC61, FSA12, FSR14]
  - on
  - off
  - executeTime: t/s (Sensor Range: t = 0.1 s ... 6553.5 s or 0 if no time specified)
  - executeType: duration|delay
  - block: lock|unlock
  - teach: <result of teach procedure>
  - state: on|off
  The attr subType must be gateway and gwCmd must be switching. This is done if the device was created by autocreate.
  For Eltako devices attributes must be set manually. Eltako devices only send on/off.
- Gateway (EEP A5-38-08)
  Dimming
  [Eltako FUD14, FUD61, FUD70, FSG14, ...]
  - on
  - off
  - block: lock|unlock
  - dim: dim/% (Sensor Range: dim = 0 % ... 100 %)
  - dimValueLast: dim/%
    Last value received from the bidirectional dimmer.
  - dimValueStored: dim/%
    Last value saved by `set <name> dim <value>`.
  - rampTime: t/s (Sensor Range: t = 1 s ... 255 s or 0 if no time specified, for Eltako: t = 1 = fast dimming ... 255 = slow dimming or 0 = dimming speed on the dimmer used)
  - teach: <result of teach procedure>
  - state: on|off
  The attr subType must be gateway, gwCmd must be dimming and attr manufID must be 00D for Eltako Devices. This is done if the device was created by autocreate.
  For Eltako devices attributes must be set manually. Eltako devices only send on/off and dim.
- Gateway (EEP A5-38-08)
  Setpoint shift
  [untested]
  - 1/K
  - setpointShift: 1/K (Sensor Range: T = -12.7 K ... 12.8 K)
  - teach: <result of teach procedure>
  - state: 1/K
  The attr subType must be gateway, gwCmd must be setpointShift. This is done if the device was created by autocreate.
- Gateway (EEP A5-38-08)
  Basic Setpoint
  [untested]
  - t/°C
  - setpoint: t/°C (Sensor Range: t = 0 °C ... 51.2 °C)
  - teach: <result of teach procedure>
  - state: t/°C
  The attr subType must be gateway, gwCmd must be setpointBasic. This is done if the device was created by autocreate.
- Gateway (EEP A5-38-08)
  Control variable
  [untested]
  - auto|heating|cooling|off
  - controlVar: cvov (Sensor Range: cvov = 0 % ... 100 %)
  - controllerMode: auto|heating|cooling|off
  - controllerState: auto|override
  - energyHoldOff: normal|holdoff
  - presence: present|absent|standby
  - teach: <result of teach procedure>
  - state: auto|heating|cooling|off
  The attr subType must be gateway, gwCmd must be controlVar. This is done if the device was created by autocreate.
- Gateway (EEP A5-38-08)
  Fan stage
  [untested]
  - 0 ... 3|auto
  - teach: <result of teach procedure>
  - state: 0 ... 3|auto
  The attr subType must be gateway, gwCmd must be fanStage. This is done if the device was created by autocreate.
- Extended Lighting Control (EEP A5-38-09)
  [untested]
  - on
  - off
  - block: unlock|on|off|local
  - blue: <blue channel value> (Range: blue = 0 ... 255)
  - dimMax: <maximum dimming value> (Range: dim = 0 ... 255)
  - dimMin: <minimum dimming value> (Range: dim = 0 ... 255)
  - green: <green channel value> (Range: green = 0 ... 255)
  - rampTime: t/s (Range: t = 0 s ... 65535 s)
  - red: <red channel value> (Range: red = 0 ... 255)
  - rgb: RRGGBB (red (R), green (G) or blue (B) color component values: 00 ... FF)
  - teach: <result of teach procedure>
  - state: on|off
  Another readings, see subtype lightCtrlState.02.
  The attr subType or subTypSet must be lightCtrl.01. This is done if the device was created by autocreate.
  The subType is associated with the subtype lightCtrlState.02.
- Manufacturer Specific Applications (EEP A5-3F-7F)
  Wireless Analog Input Module
  [Thermokon SR65 3AI, untested]
  - I1: U/V I2: U/V I3: U/V
  - input1: U/V (Sensor Range: U = 0 V ... 10 V)
  - input2: U/V (Sensor Range: U = 0 V ... 10 V)
  - input3: U/V (Sensor Range: U = 0 V ... 10 V)
  - teach: <result of teach procedure>
  - state: I1: U/V I2: U/V I3: U/V
  The attr subType must be manufProfile and attr manufID must be 002 for Thermokon Devices. This is done if the device was created by autocreate.
- Manufacturer Specific Applications (EEP A5-3F-7F)
  Thermostat Actuator
  [AWAG omnio UPH230/1x]
  - on|off
  - emergencyMode<channel>: on|off
  - nightReduction<channel>: on|off
  - setpointTemp<channel>: t/°C
  - teach: <result of teach procedure>
  - temperature<channel>: t/°C
  - window<channel>: on|off
  - state: on|off
  The attr subType must be manufProfile and attr manufID must be 005 for AWAG omnio Devices. This is done if the device was created by autocreate.
- Manufacturer Specific Applications (EEP A5-3F-7F)
  Shutter (EEP F6-02-01 ... F6-02-02)
  [Eltako FSB12, FSB14, FSB61, FSB70]
  - open|open_ack
    The status of the device will become "open" after the TOP endpoint is reached, or it has finished an "opens" or "position 0" command.
  - closed
    The status of the device will become "closed" if the BOTTOM endpoint is reached
  - stop
    The status of the device become "stop" if stop command is sent.
  - not_reached
    The status of the device become "not_reached" between one of the endpoints.
  - anglePos: α/° (Sensor Range: α = -180 ° ... 180 °)
  - endPosition: open|open_ack|closed|not_reached|not_available
  - position: pos/% (Sensor Range: pos = 0 % ... 100 %)
  - teach: <result of teach procedure>
  - state: open|open_ack|closed|not_reached|stop|teach
  The values of the reading position and anglePos are updated automatically, if the command position is sent or the reading state was changed manually to open or closed.
  Set attr subType file, attr manufID to 00D and attr model to FSB14|FSB61|FSB70 manually.
- Electronic switches and dimmers with Energy Measurement and Local Control (D2-01-00 - D2-01-12)
  [Telefunken Funktionsstecker, PEHA Easyclick, AWAG Elektrotechnik AG Omnio UPS 230/xx,UPD 230/xx]
  - on
  - off
  - autoOffTime<1...29|All|Input>: 1/s
  - channel<0...29|All|Input>: on|off
  - delayOffTime<1...29|All|Input>: 1/s
  - dayNight: day|night
  - defaultState: on|off|last
  - devTemp: t/°C|invalid
  - devTempState: ok|max|warning
  - dim<0...29|Input>: dim/% (Sensor Range: dim = 0 % ... 100 %)
  - energy<channel>: E/[Ws|Wh|KWh]
  - energyUnit<channel>: Ws|Wh|KWh
  - error<channel>: ok|warning|failure|not_supported
  - extSwitchMode<1...29|All|Input>: unavailable|switch|pushbutton|auto
  - extSwitchType<1...29|All|Input>: toggle|direction
  - firmwareVersion: [000000 ... FFFFFF]
  - loadClassification: no
  - localControl<channel>: enabled|disabled
  - loadLink: connected|disconnected
  - loadOperation: 3-wire
  - loadState: on|off
  - measurementMode: energy|power
  - measurementReport: auto|query
  - measurementReset: not_active|trigger
  - measurementDelta: E/[Ws|Wh|KWh|W|KW]
  - measurementUnit: Ws|Wh|KWh|W|KW
  - overCurrentOff<channel>: executed|ready
  - overCurrentShutdown<channel>: off|restart
  - overCurrentShutdownReset<channel>: not_active|trigger
  - power<channel>: P/[W|KW]
  - powerFailure<channel>: enabled|disabled
  - powerFailureDetection<channel>: detected|not_detected
  - powerUnit<channel>: W|KW
  - rampTime<1...3l>: 1/s
  - responseTimeMax: 1/s
  - responseTimeMin: 1/s
  - roomCtrlMode: off|comfort|comfort-1|comfort-2|economy|buildingProtection
  - serialNumber: [00000000 ... FFFFFFFF]
  - taughtInDevID<00...23>: [00000001 ... FFFFFFFE]
  - taughtInDevNum: [0 ... 23]
  - teach: <result of teach procedure>
  - teachInDev: enabled|disabled
  - state: on|off
  The attr subType must be actuator.01. This is done if the device was created by autocreate. To control the device, it must be bidirectional paired, see Bidirectional Teach-In / Teach-Out.
- Blind Control for Position and Angle (D2-05-00)
  [AWAG Elektrotechnik AG OMNIO UPJ 230/12]
  - open
    The status of the device will become "open" after the TOP endpoint is reached, or it has finished an "opens" or "position 0" command.
  - closed
    The status of the device will become "closed" if the BOTTOM endpoint is reached
  - stop
    The status of the device become "stop" if stop command is sent.
  - not_reached
    The status of the device become "not_reached" between one of the endpoints.
  - pos/% (Sensor Range: pos = 0 % ... 100 %)
  - anglePos<channel>: α/% (Sensor Range: α = 0 % ... 100 %)
  - block<channel>: unlock|lock|alarm
  - endPosition<channel>: open|closed|not_reached|unknown
  - position<channel>: unknown|pos/% (Sensor Range: pos = 0 % ... 100 %)
  - teach: <result of teach procedure>
  - state: open|closed|in_motion|stopped|pos/% (Sensor Range: pos = 0 % ... 100 %)
  The attr subType must be blindsCtrl.00 or blindsCtrl.01. This is done if the device was created by autocreate. To control the device, it must be bidirectional paired, see Bidirectional Teach-In / Teach-Out.
- Multisensor Window Handle (D2-06-01)
  [Soda GmbH]
  - T: t/°C H: -|rH/% E: -|E/lx M: off|on|invalid|not_supported|unknown
  - alarms: <alarms> (Range: alarms = 00000000 ... FFFFFFFF)
  - battery: ok|low
  - batteryLowClick: enabled|disabled
  - burglaryAlarm: off|on|invalid|not_supported|unknown
  - handle: up|down|left|right|invalid|not_supported|unknown
  - blinkInterval: t/s|unknown (Range: t = 3 s ... 255 s)
  - blinkIntervalSet: t/s|unknown (Range: t = 3 s ... 255 s)
  - brightness: E/lx|over_range|invalid|not_supported|unknown (Sensor Range: E = 0 lx ... 60000 lx)
  - buttonLeft: pressed|released|invalid|not_supported|unknown
  - buttonLeftPresses: <buttonLeftPresses> (Range: buttonLeftPresses = 00000000 ... FFFFFFFF)
  - buttonRight: pressed|released|invalid|not_supported|unknown
  - buttonRightPresses: <buttonRightPresses> (Range: buttonRightPresses = 00000000 ... FFFFFFFF)
  - energyStorage: 1/%|unknown
  - handleClosedClick: enabled|disabled
  - handleMoveClosed: <handleMoveClosed> (Range: handleMoveClosed = 00000000 ... FFFFFFFF)
  - handleMoveOpend: <handleMoveOpend> (Range: handleMoveOpend = 00000000 ... FFFFFFFF)
  - handleMoveTilted: <handleMoveTilted> (Range: handleMoveTilted = 00000000 ... FFFFFFFF)
  - humidity: rH/%|invalid|not_supported|unknown
  - motion: off|on|invalid|not_supported|unknown
  - powerOns: <powerOns> (Range: powerOns = 00000000 ... FFFFFFFF)
  - presence: absent|present|invalid|not_supported|unknown
  - protectionAlarm: off|on|invalid|not_supported|unknown
  - temperature: t/°C|invalid|not_supported|unknown (Sensor Range: t = -20 °C ... 60 °C)
  - updateInterval: t/s|unknown (Range: t = 5 s ... 65535 s)
  - updateIntervalSet: t/s|unknown (Range: t = 5 s ... 65535 s)
  - waitingCmds: <integer number>
  - window: undef|not_tilted|tilted|invalid|not_supported|unknown
  - windowTilts: <windowTilts> (Range: windowTilts = 00000000 ... FFFFFFFF)
  - state: T: t/°C H: -|rH/% E: -|E/lx M: off|on|invalid|not_supported|unknown
  The attr subType must be multisensor.01. This is done if the device was created by autocreate. To control the device, it must be bidirectional paired, see Bidirectional Teach-In / Teach-Out.
- Room Control Panels (D2-10-00 - D2-10-02)
  [Kieback & Peter RBW322-FTL]
  - T: t/°C H: -|rH/% F: 0 ... 100/% SPT: t/°C O: -|absent|present M: -|on|off
  - battery: ok|low|empty|-
  - cooling: auto|on|off|-
  - customWarning[1|2]: on|off
  - fanSpeed: 0 ... 100/%
  - fanSpeedMode: central|local
  - heating: auto|on|off|-
  - humidity: -|rH/%
  - moldWarning: on|off
  - motion: on|off|-
  - occupancy: -|absent|present
  - roomCtrlMode: buildingProtection|comfort|economy|preComfort
  - setpointBuildingProtectionTemp: -|t/°C (Range: t = 0 °C ... 40 °C)
  - setpointComfortTemp: -|t/°C (Range: t = 0 °C ... 40 °C)
  - setpointEconomyTemp: -|t/°C (Range: t = 0 °C ... 40 °C)
  - setpointPreComfortTemp: -|t/°C (Range: t = 0 °C ... 40 °C)
  - setpointTemp: t/°C (Range: t = 0 °C ... 40 °C)
  - solarPowered: yes|no
  - temperature: t/°C (Sensor Range: t = 0 °C ... 40 °C)
  - window: closed|open
  - state: T: t/°C H: -|rH/% F: 0 ... 100/% SPT: t/°C O: -|absent|present M: -|on|off
  The attr subType must be roomCtrlPanel.00. This is done if the device was created by autocreate. To control the device, it must be bidirectional paired, see Bidirectional Teach-In / Teach-Out.
- Room Control Panels (D2-11-01 - D2-11-08)
  [Thermokon EasySens SR06 LCD-2T/-2T rh -4T/-4T rh]
  - T: t/°C H: rH/% SPT: t/°C F: auto|off|1|2|3
  - cooling: on|off
  - fanSpeed: auto|off|1|2|3
  - heating: on|off
  - humidity: rH/%
  - occupancy: occupied|unoccupied
  - setpointBase: t/°C (Range: t = 15 °C ... 30 °C)
  - setpointShift: t/K (Range: t = -10 K ... 10 K)
  - setpointShiftMax: t/K (Range: t = 0 K ... 10 K)
  - setpointTemp: t/°C (Range: t = 5 °C ... 40 °C)
  - setpointType: setpointTemp|setpointShift
  - temperature: t/°C (Sensor Range: t = 0 °C ... 40 °C)
  - trigger: heartbeat|sensor|input
  - window: closed|open
  - state: T: t/°C H: rH/% SPT: t/°C F: auto|off|1|2|3
  The attr subType must be roomCtrlPanel.01. This is done if the device was created by autocreate. To control the device, it must be bidirectional paired by Smart Ack, see SmartAck Learning.
- Fan Control (D2-20-00 - D2-20-02)
  [Maico ECA x RC/RCH, ER 100 RC, untested]
  - on|off|not_supported
  - fanSpeed: 0 ... 100/%
  - error: ok|air_filter|hardware|not_supported
  - humidity: rH/%|not_supported
  - humidityCtrl: disabled|enabled|not_supported
  - roomSize: 0...350/m2|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

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`

Set

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

Get

N/A

Attributes

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

### FBDECT

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
- 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
Optional attribute to disable the call list update. When disabled, call events will be processed and the list wouldn't be updated accordingly.
Possible values: 0 => FB_CALLLIST is activated, 1 => FB_CALLLIST is deactivated.
Default Value is 0 (activated)
- disabledForIntervals HH:MM-HH:MM HH:MM-HH-MM...
Optional attribute to disable the call list update 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)
- 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..20
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 - returns a list of all currently known phonebook entries (only available when using phonebook funktionality)
- showCacheEntries - returns a list of all currently known cache entries (only available when using reverse search caching funktionality)
- showTextfileEntries - returns a list of all known entries from user given textfile (only available when using reverse search caching funktionality)

Attributes

- do_not_notify
- readingFnAttributes 0,1
- disable 0,1
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,klicktel.de,dasoertliche.de,search.ch,dasschnelle.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)
- 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 telnet 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 user for remote connect to obtain the phonebook (see fritzbox-remote-phonebook). This attribute is only needed, if you use multiple users on your FritzBox.

Generated Events:

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

Legal Notice:

- klicktel.de reverse search is powered by telegate MEDIA

### FHEM2FHEM

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

- addStateEvent
- alias_<RoomName>
  If you define a userattr alias_<RoomName> and set this attribute for a device assgined to <RoomName>, then this value will be used when displaying <RoomName>.
  Note: you can use the userattr alias_.* to allow all rooms, but in this case the attribute dropdown in the device detail view won't work for the alias_.* attributes.
- allowfrom
- allowedCommands, basicAuth, basicAuthMsg
  Please create these attributes for the corresponding allowed device, they are deprecated for the FHEMWEB instance from now on.
- closeConn
  If set, a TCP Connection will only serve one HTTP request. Seems to solve problems on iOS9 for WebApp startup.
- column
  Allows to display more than one column per room overview, by specifying the groups for the columns. Example:
  `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.
- 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 none, no token is expected. Default is random for featurelevel 5.8 and greater, and none for featurelevel below 5.8
- 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`
- 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 regexp 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).
- hiddenroom
  Comma separated list of rooms to "hide", i.e. not to show. Special values are input, detail and save, in which case the input areas, link to the detailed views or save button is hidden (although each aspect still can be addressed through URL manipulation).
  The list can also contain values from the additional "Howto/Wiki/FAQ" block.
- hiddengroup
  Comma separated list of groups to "hide", i.e. not to show in any room of this FHEMWEB instance.
  Example: attr WEBtablet hiddengroup FileLog,dummy,at,notify
- 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 }`
  Note: if the filename starts with - then it will be excluded for the automatically loaded list (e.g. -fhemweb_fbcalllist.js)
- longpoll
  Affects devices states in the room overview only.
  In this mode status update is refreshed more or less instantaneously, and state change (on/off only) is done without requesting a complete refresh from the server. Default is on.
- longpollSVG
  Reloads an SVG weblink, if an event should modify its content. Since an exact determination of the affected events is too complicated, we need some help from the definition in the .gplot file: the filter used there (second parameter if the source is FileLog) must either contain only the deviceName or have the form deviceName.event or deviceName.*. This is always the case when using the Plot editor. The SVG will be reloaded for any event triggered by this deviceName. Default is off.
- mainInputLength
  length of the maininput text widget in characters (decimal number).
- menuEntries
  Comma separated list of name,html-link pairs to display in the left-side list. Example:
  attr WEB menuEntries fhem.de,http://fhem.de,culfw.de,http://culfw.de
  attr WEB menuEntries AlarmOn,http://fhemhost:8083/fhem?cmd=set%20alarm%20on
- nameDisplay
  The argument is perl code, which is executed for each single device in the room to determine the name displayed. $DEVICE is the name of the current device, and $ALIAS is the value of the alias attribute or the name of the device, if no alias is set. E.g. you can add a a global userattr named alias_hu for the Hungarian translation, and specify nameDisplay for the hungarian FHEMWEB instance as
  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.
- 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 setList state:on,off
  define d2 dummy
  attr d2 webCmd state
  attr d2 setList state:slider,0,1,10
  define d3 dummy
  attr d3 webCmd 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.
- webname
  Path after the http://hostname:port/ specification. Defaults to fhem, i.e the default http address is http://localhost:8083/fhem
- widgetOverride
  Space spearate list of name:modifier pairs, to override the widget for a set/get/attribute specified by the module author.
  - if the modifier is ":noArg", then no further input field is displayed
  - if the modifier is ":time", then a javascript driven timepicker is displayed.
  - if the modifier is ":textField", an input field is displayed.
  - if the modifier is ":textFieldNL", an input field without label is displayed.
  - if the modifier is ":textField-long", is like textField, but upon clicking on the input field a textArea (60x25) will be opened.
  - if the modifier is ":textFieldNL-long", the behaviour is the same as :textField-long, but no label is displayed.
  - if the modifier is of the form ":slider,<min>,<step>,<max>[,1]", then a javascript driven slider is displayed. The optional ,1 at the end avoids the rounding of floating-point numbers.
  - if the modifier is of the form ":multiple,val1,val2,...", then multiple values can be selected and own values can be written, the result is comma separated.
  - if the modifier is of the form ":multiple-strict,val1,val2,...", then multiple values can be selected and no new values can be added, the result is comma separated.
  - if the modifier is of the form ":knob,min:1,max:100,...", then the jQuery knob widget will be displayed. The parameters are specified as a comma separated list of key:value pairs, where key does not have to contain the "data-" prefix.
  - if the modifier is of the form ":sortable,val1,val2,...", then the user can create a new list from the elements of the given list, can add new elements by entering a text, or delete some from the list. This new list can be sorted via drag & drop. The result is a comma separated list.
  - if the modifier is of the form ":sortable-strict,val1,val2,...", then it behaves like :sortable, without the possibility to enter text.
  - if the modifier is of the form ":sortable-given,val1,val2,...", then the specified list can be sorted via drag & drop, no elements can be added or deleted.
  - if the modifier is of the form ":uzsuToggle,state1,state2", a toggle button with two possible states is displayed. the first is the active state.
  - if the modifier is of the form ":uzsuSelect,val1,val2,...", a button bar with a button per value is displayed from which multiple values can be selected. the result is comma separated.
  - if the modifier is of the form ":uzsuSelectRadio,val1,val2,...", a button bar with a button per value is displayed from which only one value can be selected.
  - if the modifier is of the form ":uzsuDropDown,val1,val2,...", a dropdown with all values is displayed.
  - if the modifier is of the form ":uzsuTimerEntry[,modifier2]", uzsuSelect, uzsuDropDown and uzsuToggle are combined into a single line display to select a timer entry. an optional modifier can be given to select the switching value. see examples below. the result is a comma separated list of days followed by a time, an enabled indicator and the switching value all separated by a|. eg: Mo,Di,Sa,So|00:00|enabled|19.5
  - if the modifier is of the form ":uzsu[,modifier2]", multiple uzsuTimerEntry widets are combined to allow the setting of multiple switching times an optional modifier can be given to select the switching value. see examples below. the result is a space separeted list of uzsuTimerEntry results.
  - else a dropdown with all the modifier values is displayed
  If this attribute is specified for a FHEMWEB instance, then it is applied to all devices shown. Examples:
  attr FS20dev widgetOverride on-till:time
  attr WEB widgetOverride room:textField
  attr dimmer widgetOverride dim:knob,min:1,max:100,step:1,linecap:round
  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

### 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 hour minute
- day-temp night-temp lowtemp-offset windowopen-temp
- ack can-xmit can-rcv ack2 start-xmit end-xmit (only if the CUL is configured to transmit FHT protocol data)

### FHT8V

Fhem can directly control FHT8V type valves via a CUL device without an intermediate FHT. This paragraph documents one of the building blocks, the other is the PID device.
Define

`define <name> FHT8V <housecode> [IODev|FHTID]`
`<housecode>` is a four digit hex number, and must have the following relation to the housecode of the corresponding CUL device:

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

This form is chosen so that the CUL can update all FHT8V valve states within 2 minutes.
`<IODev>` must be specified if the last defined CUL device is not the one to use. Usually this is done voa the IODev attribute, but as the address checked is performed at the definition, we must use an exception here.
As an alternative you can specify the FHTID of the assigned IODev device (instead of the IODev itself), this method is needed if you are using FHT8V through FHEM2FHEM.
Examples:

`define wz FHT8V 3232`

Set

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

Get

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

Attributes

- IODev
- dummy
- ignore
- eventMap
- readingFnAttributes

### FHZ

Note: this module requires the Device::SerialPort or Win32::SerialPort module if the devices is connected via USB or a serial port.
Define

`define <name> FHZ <serial-device>`
Specifies the serial port to communicate with the FHZ1000PC or FHZ1300PC. The name(s) of the serial-device(s) depends on your distribution.
If the serial-device is called none, then no device will be opened, so you can experiment without hardware attached.
The program can service multiple devices, FS20 and FHT device commands will be sent out through the last FHZ device defined before the definition of the FS20/FHT device. To change the association, use the IODev attribute.
For GNU/Linux you may want to read our hints for GNU/Linux about multiple USB devices.
Note:The firmware of the FHZ1x00 will drop commands if the airtime for the last hour would exceed 1% (which corresponds roughly to 163 commands). For this purpose there is a command counter for the last hour (see list FHZDEVICE), which triggers with "TRANSMIT LIMIT EXCEEDED" if there were more than 163 commands in the last hour.
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`

Set

`set FHZ <variable> [<value>]`
where `value` is one of:

FHTcode
initFS20
initHMS
stopHMS
initfull
raw
open
reopen
close
time

Notes:

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

Get

`get FHZ <value>`
where `value` is one of:

init1
init2
init3
serial
fhtbuf

Notes:

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

Attributes

- do_not_notify
  Disable FileLog/notify/inform notification for a device. This affects the received signal, the set and trigger commands.
- dummy
- showtime
- loglevel
  Note:Deprecated! The module maintainer is encouraged to replace it with verbose.
  Set the device loglevel to e.g. 6 if you do not wish messages from a given device to appear in the global logfile (FHZ/FS20/FHT). E.g. to set the FHT time, you should schedule "set FHZ time" every minute, but this in turn makes your logfile unreadable. These messages will not be generated if the FHZ attribute loglevel is set to 6.
  On the other hand, if you have to debug a given device, setting its loglevel to a smaller value than the value of the global verbose attribute, it will output its messages normally seen only with higher global verbose levels.
- model (fhz1000,fhz1300)
- fhtsoftbuffer
  As the FHZ command buffer for FHT devices is limited (see fhtbuf), and commands are only sent to the FHT device every 120 seconds, the hardware buffer may overflow and FHT commands get lost. Setting this attribute implements an "unlimited" software buffer.
  Default is disabled (i.e. not set or set to 0).

### FLOORPLAN

Implements an additional entry "Floorplans" to your fhem menu, leading to a userinterface without fhem-menu, rooms or devicelists. Devices can be displayed at a defined coordinate on the screen, usually with a clickable icon allowing to switch the device on or off by clicking on it. A background-picture can be used - use e.g. a floorplan of your house, or any picture. Use floorplanstyle.css to adapt the representation.
Step-by-step setup guides are available in english and german.
Define

`define <name> FLOORPLAN`
Hint: Store fp_<name>.png in your image folder (www/images/default , www/pgm2 or FHEM) to use it as background picture.
Example:

`define Groundfloor FLOORPLAN
fp_Groundfloor.png`

Set

- N/A

Get

`get <name> config`
Displays the configuration of the floorplan <name> with all attributes. Can be used in an include-file.

Attributes

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

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

Hint: no blanks between parameters
- fp_arrange
  Activates the "arrange mode" which shows an additional menu on the screen to choose style and description.
  When the arrange-mode is activated, devices can be placed freely on the screen by drag&drop. allowing to place devices easily on the screen.
  Example:
  `attr Groundfloor fp_arrange 1`
  `attr Groundfloor fp_arrange WEB #activates arrange mode for frontend-device WEB only`
- stylesheet
  Explicitely sets your personal stylesheet for the floorplan. This overrides the standard stylesheet. The standard stylesheet for floorplans is `floorplanstyle.css`. If the stylesheetPrefix is set for the corresponding FHEMWEB instance, this same `stylesheetPrefix` is also prepended to the stylesheet for floorplans.
  All stylesheets must be stored in the stylesheet subfolder of the fhem filesystem hierarchy. Store your personal stylesheet along with `floorplanstyle.css` in the same folder.
  Example:
  `attr Groundfloor stylesheet myfloorplanstyle.css`
- fp_default
  The floorplan startscreen is skipped if this attribute is assigned to one of the floorplans in your installation.
Example:

`attr Groundfloor fp_default 1`

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

`attr Groundfloor fp_noMenu 1`

- commandfield
  Adds a fhem-commandfield to the floorplan screen.
Example:

`attr Groundfloor commandfield 1`

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

`attr Groundfloor fp_backgroundimg foobar.png`

- fp_viewport
  Allows usage of a user-defined viewport-value for touchpad.
  Default-viewport-value is "width=768".
- fp_roomIcons
  Space separated list of floorplan:icon pairs, to assign icons to the floorplan-menu, just like the functionality for rooms in FHEMWEB. Example:
  attr Grundriss fp_roomIcons Grundriss:control_building_empty Media:audio_eq
- Inherited from FHEMWEB
  The following attributes are inherited from the underlying FHEMWEB instance:
  smallscreen
  touchpad
  refresh
  plotmode
  plotsize
  webname
  redirectCmds
  longpoll
  allowedCommands

### FRAMEBUFFER

Provides a device to display arbitrary content on a linux framebuffer device

You need to have the perl module `GD` installed. This module is most likely not available for small systems like Fritz!Box.

FRAMEBUFFER uses RSS to create an image that is displayed on the framebuffer.
The binary program fbvs is required to display the image. You can download it from github.

Define

`define <name> FRAMEBUFFER <framebuffer_device_name>`
Defines a framebuffer device. `<framebuffer_device_name>` is the name of the linux device file for the kernel framebuffer device, e.g. /dev/fb1 or /dev/fb0. Examples:

`define display FRAMEBUFFER /dev/fb1`
`define TV FRAMEBUFFER /dev/fb0`

Set

`set <name> absLayoutNo <number>`
A list of layout files can be defined with `attr layoutList`, see below. This command selects the layout with the given number from this list and displays it. This can e.g. be useful if bound to a key of a remote control to display a specific layout.

`set <name> layoutFilename <name> [<timeout in seconds>]`
Displays the image described by the layout in file <name>. If <name> is an absolute path name it is used as is to access the file. Otherwise the attribute <layoutBasedir> is prepended to the <name>. If a timeout is given, the image is only displayed for timeout seconds before the previously displayed image is displayed again. Useful for displaying an image only for a certain time after an event has occured.

`set <name> relLayoutNo <number>`
Like absLayoutNo this displays a certain image from the layoutList. Here <number> is added to the current layout number. So
`set <name> relLayoutNo 1` displays the next image from the list while
`set <name> relLayoutNo -1`
displays the previous one. Useful if bound to a next/previous key on a remote control to scroll through all defined layouts.

`set <name> updateDisplay`
Refreshes the display defined by the currently active layout.

Attributes

`size <width>x<height>`
The dimensions of the display in pixels. Images will generated using this size. If the size is greater than the actual display size they will be scaled to fit. As this requires computing performance it should be avoided by defining the size to match the display size.
Example
`attr <name> size 128x160`

`layoutBasedir <directory name>`
Directory that contains the layout files. If a layout filename is specified using a relative path `layoutBasedir` will be prepended before accessing the file.
Example
`attr <name> layoutBasedir /opt/fhem/layouts`

`layoutList <file1> [<file2>] ...`
Space separated list of layout files. These will be used by `absLayoutNo` and `relLayoutNo`. `layoutBasedir` will be prepended to each file if it is a relative path.
Example
`attr <name> layoutList standard.txt wetter.txt schalter.txt`

`update_interval <interval>`
Update interval in minutes. The currently displayed layout will be refreshed every <interval> minutes. The first interval will be scheduled to the beginning of the next minute to help create an accurate time display.
Example
`attr <name> update_interval 1`

`debugFile <file>`
Normally the generated image isn't written to a file. To ease debugging of layouts the generated image is written to the filename specified by this attribute. This attribute shouldn't be set during normal operation.

`startLayoutNo <number>`
The number of the layout to be displayed on startup of the FRAMEBUFFER device.

bgcolor <color>
Sets the background color. <color> is a 6-digit hex number, every 2 digits determining the red, green and blue color components as in HTML color codes (e.g.`FF0000` for red, `C0C0C0` for light gray).

enableCmd <fhem cmd>
if set this command is executed before a layout with a timeout is displayed. This can e.g. be used to enable a backlight.

disableCmd <fhem cmd>
if set this command is executed after a layout with a timeout has expired. This can e.g. be used to disable a backlight.

Usage information

This module requires the binary program fbvs to be installed in /usr/local/bin and it must be executable by user fhem. fbvs (framebuffer viewer simple) is a stripped down version of fbv that can only display png images. It reads the image from stdin, displays it on the framebuffer and terminates afterwards. This module generates a png image based on a layout description internally and then pipes it to fbvs for display.

Layout definition

FRAMEBUFFER uses the same layout definition as RSS. In fact FRAMEBUFFER calls RSS to generate an image.

### FRITZBOX

(en | de)

Controls some features of a Fritz!Box router. Connected Fritz!Fon's (MT-F, MT-D, C3, C4) can be used as signaling devices. MP3 files and Text2Speech can be played as ring tone or when calling phones.
For detail instructions, look at and please maintain the FHEM-Wiki.
The modul switches in local mode if FHEM runs on a Fritz!Box (as root user!). Otherwise, it tries to open a web or telnet connection to "fritz.box", so telnet (#96*7*) has to be enabled on the Fritz!Box. For remote access the password must once be set.
The box is partly controlled via the official TR-064 interface but also via undocumented interfaces between web interface and firmware kernel. The modul works best with Fritz!OS 6.24. AVM has removed internal interfaces (telnet, webcm) from later Fritz!OS versions without replacement. For these versions, some modul functions are hence restricted or do not work at all (see remarks to required API).
The modul was tested on Fritz!Box 7390 and 7490 with Fritz!OS 6.20 and higher.
Check also the other Fritz!Box moduls: SYSMON and FB_CALLMONITOR.
The modul uses the Perl modul 'Net::Telnet', 'JSON::XS', 'LWP', 'SOAP::Lite' for remote access.
Define

`define <name> FRITZBOX [host]`
The attribute host is the web address (name or IP) of the Fritz!Box. If it is missing, the modul switches in local mode or uses the default host address "fritz.box".
Example: `define Fritzbox FRITZBOX`
The FritzOS has a hidden function (easter egg).
`define MyEasterEgg weblink htmlCode { FRITZBOX_fritztris("Fritzbox") }`

Set

- `set <name> alarm <number> [on|off] [time] [once|daily|Mo|Tu|We|Th|Fr|Sa|So]`
  Switches the alarm number (1, 2 or 3) on or off (default is on). Sets the time and weekday. If no state is given it is switched on.
  Requires the API: Telnet or webcm.
- `set <name> call <number> [duration] [say:text|play:MP3URL]`
  Calls for 'duration' seconds (default 60) the given number from an internal port (default 1 or attribute 'ringWithIntern'). If the call is taken a text or sound can be played as music on hold (moh). The internal port will also ring. Say and play requires the API: Telnet or webcm.
- `set <name> checkAPIs`
  Restarts the initial check of the programming interfaces of the FRITZ!BOX.
- `set <name> customerRingTone <internalNumber> <fullFilePath>`
  Uploads the file fullFilePath on the given handset. Only mp3 or G722 format is allowed.
  The file has to be placed on the file system of the fritzbox.
  The upload takes about one minute before the tone is available.
- `set <name> dect <on|off>`
  Switches the DECT base of the box on or off. Requires the API: Telnet or webcm.
- `set <name> diversity <number> <on|off>`
  Switches the call diversity number (1, 2 ...) on or off. A call diversity for an incoming number has to be created with the Fritz!Box web interface. Requires the API: Telnet, webcm or TR064 (>=6.50).
  Note! Only a diversity for a concret home number and without filter for the calling number can be set. Hence, an approbriate diversity-reading must exist.
- `set <name> guestWLAN <on|off>`
  Switches the guest WLAN on or off. The guest password must be set. If necessary, the normal WLAN is also switched on.
- `set <name> moh <default|sound|customer> [<MP3FileIncludingPath|say:Text>]`
  Example: `set fritzbox moh customer say:Die Wanne ist voll`
  `set fritzbox moh customer /var/InternerSpeicher/warnung.mp3`
  Changes the 'music on hold' of the Box. The parameter 'customer' allows to upload a mp3 file. Alternatively a text can be spoken with "say:". The music on hold has always a length of 8.2 s. It is played continousely during the broking of calls or if the modul rings a phone and the call is taken. So, it can be used to transmit little messages of 8 s.
- `set <name> password <password>`
  Stores the password for remote telnet access.
- `set <name> ring <intNumbers> [duration [ringTone]] [show:Text] [say:Text | play:MP3URL]`
  Example:
    `set fritzbox ring 611,612 5 Budapest show:It is raining`
    `set fritzbox ring 611 8 say:(en)It is raining`
    `set fritzbox ring 610 10 play:http://raspberrypi/sound.mp3`
  Rings the internal numbers for "duration" seconds and (on Fritz!Fons) with the given "ring tone" name. Different internal numbers have to be separated by a comma (without spaces).
  Default duration is 5 seconds. The Fritz!Box can create further delays. Default ring tone is the internal ring tone of the device. Ring tone will be ignored for collected calls (9 or 50).
  If the call is taken the callee hears the "music on hold" which can also be used to transmit messages.
  The parameter ringtone, show:, say: and play: require the API Telnet or webcm.
  If the attribute 'ringWithIntern' is specified, the text behind 'show:' will be shown as the callers name. Maximal 30 characters are allowed.
  On Fritz!Fons the parameter 'say:' can be used to let the phone speak a message (max. 100 characters) instead of using the ringtone. Alternatively, a MP3 link (from a web server) can be played with 'play:'. This creates the internet radio station 'FHEM' and uses translate.google.com for text2speech. It will always play the complete text/sound. It will than ring with standard ring tone until the end of the 'ring duration' is reached. Say and play may work only with one single Fritz!Fon at a time.
  The behaviour may vary depending on the Fritz!OS.
- `set <name> sendMail [to:<Address>] [subject:<Subject>] [body:<Text>]`
  Sends an email via the email notification service that is configured in push service of the Fritz!Box. Use "\n" for line breaks in the body. All parameters can be omitted. Make sure the messages are not classified as junk by your email client.
  Requires Telnet access to the box.
- `set <name> startRadio <internalNumber> [name or number]`
  Plays the internet radio on the given Fritz!Fon. Default is the current ring tone radio station of the phone. So, not the station that is selected at the handset. An available internet radio can be selected by its name or (reading) number.
- `set <name> tam <number> <on|off>`
  Switches the answering machine number (1, 2 ...) on or off. The answering machine has to be created on the Fritz!Box web interface.
- `set <name> update`
  Starts an update of the device readings.
- `set <name> wlan <on|off>`
  Switches WLAN on or off.

Get

- `get <name> ringTones`
  Shows the list of ring tones that can be used.
- `get <name> shellCommand <Command>`
  Runs the given command on the Fritz!Box shell and returns the result. Can be used to run shell commands not included in this modul.
  Only available if the attribute "allowShellCommand" is set.
- `get <name> tr064Command <service> <control> <action> [[argName1 argValue1] ...]`
  Executes TR-064 actions (see API description of AVM).
  argValues with spaces have to be enclosed in quotation marks.
  Example: `get Fritzbox tr064Command X_AVM-DE_OnTel:1 x_contact GetDECTHandsetInfo NewDectID 1`
  Only available if the attribute "allowTR064Command" is set.
- `get <name> tr064ServiceListe`
  Shows a list of TR-064 services and actions that are allowed on the device.

Attributes

- `allowShellCommand <0 | 1>`
  Enables the get command "shellCommand"
- `allowTR064Command <0 | 1>`
  Enables the get command "tr064Command"
- `boxUser <user name>`
  User name that is used for TR064 or other web based access. By default no user name is required to login.
  If the Fritz!Box is configured differently, the user name has to be defined with this attribute.
- `defaultCallerName <Text>`
  The default text to show on the ringing phone as 'caller'.
  This is done by temporarily changing the name of the calling internal number during the ring.
  Maximal 30 characters are allowed. The attribute "ringWithIntern" must also be specified.
  Required API: Telnet or webcmd
- `defaultUploadDir <fritzBoxPath>`
  This is the default path that will be used if a file name does not start with / (slash).
  It needs to be the name of the path on the Fritz!Box. So, it should start with /var/InternerSpeicher if it equals in Windows \\ip-address\fritz.nas
- `forceTelnetConnection <0 | 1>`
  Always use telnet for remote access (instead of access via the WebGUI or TR-064).
  This attribute should be enabled for older boxes/firmwares.
- `fritzBoxIP <IP Address>`
  Depreciated.
- `INTERVAL <seconds>`
  Polling-Interval. Default is 300 (seconds). Smallest possible value is 60.
- `m3uFileLocal </path/fileName>`
  Can be used as a work around if the ring tone of a Fritz!Fon cannot be changed because of firmware restrictions (missing telnet or webcm).
  How it works: If the FHEM server has also a web server running, the FritzFon can play a m3u file from this web server as an internet radio station. For this an internet radio station on the FritzFon must point to the server URL of this file and the internal ring tone must be changed to that station.
  If the attribute is set, the server file "m3uFileLocal" (local address of the FritzFon URL) will be filled with the URL of the text2speech engine (say:) or a MP3-File (play:). The FritzFon will then play this URL.
- `ringWithIntern <1 | 2 | 3>`
  To ring a fon a caller must always be specified. Default of this modul is 50 "ISDN:Wählhilfe".
  To show a message (default: "FHEM") during a ring the internal phone numbers 1-3 can be specified here. The concerned analog phone socket must exist.
- `telnetTimeOut <seconds>`
  Maximal time to wait for an answer during a telnet session. Default is 10 s.
- `telnetUser <user name>`
  User name that is used for telnet access. By default no user name is required to login.
  If the Fritz!Box is configured differently, the user name has to be defined with this attribute.
- `useGuiHack <0 | 1>`
  If the APIs do not allow the change of the ring tone (Fritz!OS >6.24), check the WIKI (German) to understand the use of this attribute.
- readingFnAttributes

Readings

- alarm 1 - Name of the alarm clock 1
- alarm 1_state - Current state of the alarm clock 1
- alarm 1_target - Internal number of the alarm clock 1
- alarm 1_time - Alarm time of the alarm clock 1
- alarm 1_wdays - Weekdays of the alarm clock 1
- box_dect - Current state of the DECT base
- box_fwVersion - Firmware version of the box, if outdated then '(old)' is appended
- box_guestWlan - Current state of the guest WLAN
- box_guestWlanCount - Number of devices connected to guest WLAN
- box_guestWlanRemain - Remaining time until the guest WLAN is switched off
- box_ipExtern - Internet IP of the Fritz!Box
- box_model - Fritz!Box model
- box_moh - music-on-hold setting
- box_model - Fritz!Box model
- box_powerRate - current power in percent of maximal power
- box_rateDown - average download rate in the last update interval
- box_rateUp - average upload rate in the last update interval
- box_stdDialPort - standard caller port when using the dial function of the box
- box_tr064 - application interface TR-064 (needed by this modul)
- box_tr069 - provider remote access TR-069 (safety issue!)
- box_wlanCount - Number of devices connected via WLAN
- box_wlan_2.4GHz - Current state of the 2.4 GHz WLAN
- box_wlan_5GHz - Current state of the 5 GHz WLAN
- dect 1 - Name of the DECT device 1
- dect 1_alarmRingTone - Alarm ring tone of the DECT device 1
- dect 1_custRingTone - Customer ring tone of the DECT device 1
- dect 1_fwVersion - Firmware Version of the DECT device 1
- dect 1_intern - Internal number of the DECT device 1
- dect 1_intRingTone - Internal ring tone of the DECT device 1
- dect 1_manufacturer - Manufacturer of the DECT device 1
- dect 1_model - Model of the DECT device 1
- dect 1_radio - Current internet radio station ring tone of the DECT device 1
- diversity 1 - Own (incoming) phone number of the call diversity 1
- diversity 1_dest - Destination of the call diversity 1
- diversity 1_state - Current state of the call diversity 1
- fon 1 - Internal name of the analog FON port 1
- fon 1_intern - Internal number of the analog FON port 1
- fon 1_out - Outgoing number of the analog FON port 1
- gsm_internet - connection to internet established via GSM stick
- gsm_rssi - received signal strength indication (0-100)
- gsm_state - state of the connection to the GSM network
- gsm_technology - GSM technology used for data transfer (GPRS, EDGE, UMTS, HSPA)
- mac_01_26_FD_12_01_DA - MAC address and name of an active network device.
  If connect via WLAN, the term "WLAN" and (from boxes point of view) the down- and upload rate and the signal strength is added. For LAN devices the LAN port and its speed is added. Inactive or removed devices get first the value "inactive" and will be deleted during the next update.
- radio 01 - Name of the internet radio station 01
- tam 1 - Name of the answering machine 1
- tam 1_newMsg - New messages on the answering machine 1
- tam 1_oldMsg - Old messages on the answering machine 1
- tam 1_state - Current state of the answering machine 1
- user 01 - Name of user/IP 1 that is under parental control
- user 01_thisMonthTime - this month internet usage of user/IP 1 (parental control)
- user 01_todaySeconds - today's internet usage in seconds of user/IP 1 (parental control)
- user 01_todayTime - today's internet usage of user/IP 1 (parental control)

### FRM

connects fhem to Arduino using the Firmata protocol.
A single FRM device can serve multiple FRM-clients.
Clients of FRM are:
FRM_IN for digital input
FRM_OUT for digital out
FRM_AD for analog input
FRM_PWM for analog output (pulse_width_modulated)
FRM_RGB control multichannel/RGB-LEDs by pwm
FRM_SERVO for pwm-controled servos as being used in modelmaking
FRM_LCD output text to LCD attached via I2C
FRM_I2C to read data from integrated circutes attached to Arduino supporting the i2c-protocol.
OWX to read/write sensors and actors on 1-Wire bus.
Each client stands for a Pin of the Arduino configured for a specific use (digital/analog in/out) or an integrated circuit connected to Arduino by i2c.
Note: this module is based on Device::Firmata module (perl-firmata). perl-firmata is included in FHEM-distributions lib-directory. You can download the latest version as a single zip file from github.
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> FRM {<device> | <port> [global]}`
Specifies the FRM device.
- USB-connected devices:
  `<device>` specifies the serial port to communicate with the Arduino. The name of the serial-device depends on your distribution, under linux the cdc_acm kernel module is responsible, and usually a /dev/ttyACM0 device will be created. If your distribution does not have a cdc_acm module, you can force usbserial to handle the Arduino by the following command:
  `modprobe usbserial vendor=0x03eb product=0x204b` In this case the device is most probably /dev/ttyUSB0.
  You can also specify a baudrate if the device name contains the @ character, e.g.: /dev/ttyACM0@38400
  If the baudrate is "directio" (e.g.: /dev/ttyACM0@directio), then the perl module Device::SerialPort is not needed, and fhem opens the device with simple file io. This might work if the operating system uses sane defaults for the serial parameters, e.g. some Linux distributions and OSX.
  The Arduino has to run either 'StandardFirmata' or 'ConfigurableFirmata'. StandardFirmata supports Digital and Analog-I/O, Servo and I2C. In addition to that ConfigurableFirmata supports 1-Wire and Stepper-motors.
  You can find StandardFirmata in the Arduino-IDE under 'Examples->Firmata->StandardFirmata
  ConfigurableFirmata has to be installed manualy. See ConfigurableFirmata on GitHub or FHEM-Wiki
- Network-connected devices:
  `<port>` specifies the port the FRM device listens on. If `global` is specified the socket is bound to all local IP addresses, otherwise to localhost only.
  The Arduino has to run either 'StandardFirmataEthernet' or 'ConfigurableFirmata'. StandardFirmataEthernet supports Digital and Analog-I/O, Servo and I2C. In addition to that ConfigurableFirmata supports 1-Wire and Stepper-motors.
  The connection is initiated by the Arduino in client-mode. Therefore the IP address and port of the fhem-server has to be configured in the Arduino, so it knows where to connect to.
  As of now only a single Arduino per FRM-device configured is supported. Multiple Arduinos may connect to different FRM-devices configured for different ports.
  You can find StandardFirmataEthernet in the Arduino-IDE under 'Examples->Firmata->StandardFirmataEthernet
  ConfigurableFirmata has to be installed manually. See ConfigurableFirmata on GitHub or FHEM-Wiki
- If the device is called none, then no device will be opened, so you can experiment without hardware attached.

Set

- `set <name> init`
  reinitializes the FRM-Client-devices configured for this Arduino
- `set <name> reset`
  does a complete reset of FRM by disconnecting from, reconnecting to and reinitializing the Arduino and FRM internals and all attached FRM-client-devices

Attributes

- i2c-config
  Configure the Arduino for ic2 communication. This will enable i2c on the i2c_pins received by the capability-query issued during initialization of FRM.
  As of Firmata 2.3 you can set a delay-time (in microseconds, max. 65535, default 0) that will be inserted into i2c protocol when switching from write to read. This may be necessary because Firmata i2c write does not block on the fhem side so consecutive i2c write/read operations get queued and will be executed on the Firmata device in a different time sequence. Use the maximum operation time required by the connected i2c devices (e.g. 30000 for the BMP180 with triple oversampling, see i2c device manufacturer documentation for details).
  See: Firmata Protocol details about I2C
- sampling-interval
  Configure the interval Firmata reports analog data to FRM (in milliseconds, max. 65535).
  See: Firmata Protocol details about Sampling Interval

### FRM_AD

represents a pin of an Arduino running Firmata configured for analog input.
The value read is stored in reading 'state'. Range is from 0 to 1023 (10 Bit)
Requires a defined FRM-device to work.
Define

`define <name> FRM_AD <pin>`
Defines the FRM_AD device. <pin> is the arduino-pin to use.

Set

N/A

Get

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

Attributes

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

### FRM_I2C

represents an integrated curcuit connected to the i2c-pins of an Arduino running Firmata
Requires a defined FRM-device to work.
this FRM-device has to be configures for i2c by setting attr 'i2c-config' on the FRM-device
it reads out the ic-internal storage in intervals of 'sampling-interval' as set on the FRM-device
Define

`define <name> FRM_I2C <i2c-address> <register> <bytes-to-read>`
Specifies the FRM_I2C device.
- i2c-address is the (device-specific) address of the ic on the i2c-bus
- register is the (device-internal) address to start reading bytes from.
- bytes-to-read is the number of bytes read from the ic

Set

N/A

Get

N/A

Attributes

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

### FRM_IN

represents a pin of an Arduino running Firmata configured for digital input.
The current state of the arduino-pin is stored in reading 'state'. Values are 'on' and 'off'.
Requires a defined FRM-device to work.
Define

`define <name> FRM_IN <pin>`
Defines the FRM_IN device. <pin>> is the arduino-pin to use.

Set

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

Get

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

Attributes

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

### FRM_LCD

deprecated, use I2C_LCD

### FRM_OUT

represents a pin of an Arduino running Firmata configured for digital output.
Requires a defined FRM-device to work.
Define

`define <name> FRM_OUT <pin>`
Defines the FRM_OUT device. <pin>> is the arduino-pin to use.

Set

`set <name> on|off`

set extensions are supported

Get

N/A

Attributes

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

### FRM_PWM

represents a pin of an Arduino running Firmata configured for analog output.
The value set will be output by the specified pin as a pulse-width-modulated signal.
Requires a defined FRM-device to work.
Define

`define <name> FRM_PWM <pin>`
Defines the FRM_PWM device. <pin>> is the arduino-pin to use.

Set

`set <name> on`
sets the pulse-width to 100%

`set <name> off`
sets the pulse-width to 0%

set extensions are supported

`set <name> toggle`
toggles the pulse-width in between to the last value set by 'value' or 'dim' and 0 respectivly 100%

`set <name> value <value>`
sets the pulse-width to the value specified
Range is from 0 to 255 (for 8-bit resolution) (see analogWrite() for details)

`set <name> dim <value>`
sets the pulse-width to the value specified in percent
Range is from 0 to 100

`set <name> dimUp`
increases the pulse-width by 10%

`set <name> dimDown`
decreases the pulse-width by 10%

Get

N/A

Attributes

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

### FRM_RGB

allows to drive LED-controllers and other multichannel-devices that use PWM as input by an Arduino running Firmata
The value set will be output by the specified pins as pulse-width-modulated signals.
Requires a defined FRM-device to work.
Define

`define <name> FRM_RGB <pin> <pin> <pin> [pin...]`
Defines the FRM_RGB device. <pin>> are the arduino-pin to use.
For rgb-controlled devices first pin drives red, second pin green and third pin blue.

Set

`set <name> on`
sets the pulse-width of all configured pins to 100%

`set <name> off`
sets the pulse-width of all configured pins to 0%

set extensions are supported

`set <name> toggle`
toggles in between the last dimmed value, 0% and 100%. If no dimmed value was set before defaults to pulsewidth 50% on all channels

`set <name> rgb <value>`
sets the pulse-width of all channels at once. Also sets the value toggle can switch to
Value is encoded as hex-string, 2-digigs per channel (e.g. FFFFFF for reguler rgb)

`set <name> pct <value>`
dims all channels at once while leving the ratio in between the channels unaltered.
Range is 0-100 ('pct' stands for 'percent')

`set <name> dimUp`
dims up by 10%

`set <name> dimDown`
dims down by 10%

Get

`get <name> rgb`
returns the values set for all channels. Format is hex, 2 nybbles per channel.

`get <name> RGB`
returns the values set for all channels in normalized format. Format is hex, 2 nybbles per channel. Values are scaled such that the channel with the highest value is set to FF. The real values are calculated by multipying each byte with the value of 'pct'.

`get <name> pct`
returns the value of the channel with the highest value scaled to the range of 0-100 (percent).

Attributes

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

### FRM_ROTENC

represents a rotary-encoder attached to two pins of an Arduino running Firmata
Requires a defined FRM-device to work.
Define

`define <name> FRM_ROTENC <pinA> <pinB> [id]`
Defines the FRM_ROTENC device. <pinA>> and <pinA>> are the arduino-pins to use.
[id] is the instance-id of the encoder. Must be a unique number per FRM-device (rages from 0-4 depending on Firmata being used, optional if a single encoder is attached to the arduino).

Set
- reset
  resets to value of 'position' to 0
- offset <value>
  set offset value of 'position'
Get

- position
  returns the position of the rotary-encoder attached to pinA and pinB of the arduino
  the 'position' is the sum of 'value' and 'offset'
- offset
  returns the offset value
  on shutdown of fhem the latest position-value is saved as new offset.
- value
  returns the raw position value as it's reported by the rotary-encoder attached to pinA and pinB of the arduino
  this value is reset to 0 whenever Arduino restarts or Firmata is reinitialized

Attributes

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

### FRM_SERVO

represents a pin of an Arduino running Firmata configured to drive a pwm-controlled servo-motor.
The value set will be drive the shaft of the servo to the specified angle. see Servo.write for values and range
Requires a defined FRM-device to work.
Define

`define <name> FRM_SERVO <pin>`
Defines the FRM_SERVO device. <pin>> is the arduino-pin to use.

Set

`set <name> angle <value>`
sets the angle of the servo-motors shaft to the value specified (in degrees).

Get

N/A

Attributes

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

### FRM_STEPPER

represents a stepper-motor attached to digital-i/o pins of an Arduino running Firmata
Requires a defined FRM-device to work.
Define

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

Set

`set <name> reset`
- resets the reading 'position' to 0 without moving the motor
`set <name> position <position> [speed] [acceleration] [deceleration]`
- moves the motor to the absolute position specified. positive or negative integer
  speed (10 * revolutions per minute, optional), defaults to 30, higher numbers are faster) At 2048 steps per revolution (28byj-48) a speed of 30 results in 3 rev/min
  acceleration and deceleration are optional.
`set <name> step <stepstomove> [speed] [accel] [decel]`
- moves the motor the number of steps specified. positive or negative integer
  speed, accelleration and deceleration are optional.

Get

N/A

Attributes

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

### FReplacer

This module provides a generic way to modify the contents of a file with Readings of other devices or the result of Perl expressions.
The typical use case is a custom designed SVG graphics template file which contains place holders that will be replaced with actual values.
The resulting SVG file can then optionally be converted to a PNG file which can be used as an online screensaver for Kindle devices for example.
Define

`define <name> FReplacer <InputFile> <OutputFile> <Interval>`
The module reads the given InputFile every Interval seconds, replaces strings with the results of expressions as defined in attributes and writes the result to the OutputFile
Example:

`define fr FReplacer /opt/fhem/www/images/template.svg /opt/fhem/www/images/status.svg 60`

Configuration of FReplacer Devices

Specify pairs of `attr FxxRegex` and `attr FxxReading` or `attr FxxExpr` to define which strings / placeholders in the InputFile should be replaced with which redings / expressions
Example:

`define fr FReplacer /opt/fhem/www/images/template.svg /opt/fhem/www/images/status.svg 60
attr fr Rep01Regex HeizungStat
attr fr Rep01Reading WP:Status
attr fr Rep01MaxAge 600:Heizung Aus
attr fr Rep02Regex AbluftTemp
attr fr Rep02Reading Lueftung:Temp_Abluft
attr fr Rep02Format "%.1f"
attr fr Rep03Regex AussenTemp
attr fr Rep03Expr sprintf("%.1f", ReadingsVal("Lueftung", "Temp_Aussen", 0))
`

If you want to convert a resulting SVG file to a PNG e.g. for use as online screen saver on a Kindle device,
you have to specify the external conversion command with the attribute PostCommand, for Example:

`attr fr PostCommand convert /opt/fhem/www/images/status.svg -type GrayScale -depth 8 /opt/fhem/www/images/status.png 2>/dev/null &`

If you want to convert the replacement text from Readings to UTF8, e.g. to make special characters / umlauts display correctly, specify

`attr fr ReplacementEncode UTF-8`

Set-Commands

- ReplaceNow
starts a replace without waiting for the interval

Get-Commands

none

Readings

- LastUpdate
Date / Time of the last update of the output file / image. This reading is formatted with strftime and the default format string is "%d.%m.%Y %T".
This can be changed with the attribute LUTimeFormat.

Attributes

- Rep[0-9]+Regex
defines the regex to be used for finding the right string to be replaced with the corresponding Reading / Expr result
- Rep[0-9]+Reading
defines a device and reading to be used as replacement value. It is specified as devicename:readingname:default_value.
The default_value is optional and defaults to 0. If the reading doesn't exist, default_value is used.
- Rep[0-9]+MaxAge
this can optionally be used together with RepReading to define a maximum age of the reading. It is specified as seconds:replacement. If the corresponding reading has not been updated for the specified number of seconds, then the replacement is used instead of the reading to do the replacement and further RepExpr or RepFormat attributes will be ignored for this value
If you specify the replacement as {expr} then it is evaluated as a perl expression instead of a string.
- Rep[0-9]+MinValue
this can optionally be used together with RepReading to define a minimum value of the reading. It is specified as min:replacement. If the corresponding reading is too small, then the replacement string is used instead of the reading to do the replacement and further RepExpr or RepFormat attributes will be ignored for this value
If you specify the replacement as {expr} then it is evaluated as a perl expression instead of a string.
- Rep[0-9]+MaxValue
this can optionally be used together with RepReading to define a maximum value of the reading. It is specified as max:replacement. If the corresponding reading is too big, then the replacement string is used instead of the reading to do the replacement and further RepExpr or RepFormat attributes will be ignored for this value
If you specify the replacement as {expr} then it is evaluated as a perl expression instead of a string.
- Rep[0-9]+Expr
defines an optional expression that can be used to compute the replacement value. If RepExpr is used together with RepReading then the expression is evaluated after getting the reading and the value of the reading can be used in the expression as $replacement.
If only RepExpr is specified then readings can be retrieved with the perl function ReadingsVal() inside the expression.
If neither RepExpr nor RepReading is specified then the match for the correspondig regex will be replaced with an empty string.
- Rep[0-9]+Format
defines an optional format string to be used in a sprintf statement to format the replacement before it is applied.
Can be used with RepReading or RepExpr or both.
- LUTimeFormat
defines a time format string (see Posix strftime format) to be used when creating the reading LastUpdate.
- PostCommand
Execute an external command after writing the output file, e.g. to convert a resulting SVG file to a PNG file. For an eInk Kindle you need a PNG in 8 bit greyscale format. A simple example to call the convert utility from ImageMagick would be
`attr fr PostCommand convert /opt/fhem/www/images/status.svg -type GrayScale -depth 8 /opt/fhem/www/images/status.png 2>/dev/null &`
a more advanced example that starts inkscape before Imagemagick to make sure that embedded Icons in a SVG file are converted correctly could be
`attr fr PostCommand bash -c 'inkscape /opt/fhem/www/images/status.svg -e=tmp.png;; convert tmp.png -type GrayScale -depth 8 /opt/fhem/www/images/status.png' >/dev/null 2>&1 &`
or even
`attr fr PostCommand bash -c 'inkscape /opt/fhem/www/images/status.svg -e=tmp.png -b=rgb\(255,255,255\) --export-height=1024 --export-width=758;; convert tmp.png -type GrayScale -depth 8 /opt/fhem/www/images/status.png' >/dev/null 2>&1 &`
Inkscape might be needed because ImageMagick seems to have problems convertig SVG files with embedded icons. However a PNG file created by Inkscape is not in 8 bit greyscale so Imagemagick can be run after Inkscape to convert to 8 bit greyscale
- ReplacementEncode
defines an encoding to apply to the replacement string, e.g. UTF-8

### FS20

The FS20 protocol is used by a wide range of devices, which are either of the sender/sensor category or the receiver/actuator category. The radio (868.35 MHz) messages are either received through an FHZ or an CUL device, so this must be defined first.
Define

`define <name> FS20 <housecode> <button> [fg <fgaddr>] [lm <lmaddr>] [gm FF]`
The values of housecode, button, fg, lm, and gm can be either defined as hexadecimal value or as ELV-like "quad-decimal" value with digits 1-4. We will reference this ELV-like notation as ELV4 later in this document. You may even mix both hexadecimal and ELV4 notations, because FHEM can detect the used notation automatically by counting the digits.

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

Examples:

`define lamp FS20 7777 00 fg F1 gm F`
`define roll1 FS20 7777 01`
`define otherlamp FS20 24242424 1111 fg 4412 gm 4444`
`define otherroll1 FS20 24242424 1114`

Set

`set <name> <value> [<time>]`
where `value` is one of:

`dim06% dim12% dim18% dim25% dim31% dim37% dim43% dim50%
dim56% dim62% dim68% dim75% dim81% dim87% dim93% dim100%
dimdown
dimup
dimupdown
off
off-for-timer
on # dimmer: set to value before switching it off
on-for-timer # see the note
on-old-for-timer # set to previous (before switching it on)
ramp-on-time # time to reach the desired dim value on dimmers
ramp-off-time # time to reach the off state on dimmers
reset
sendstate
timer
toggle # between off and previous dim val
`

The set extensions are also supported.
Examples:

`set lamp on`
`set lamp1,lamp2,lamp3 on`
`set lamp1-lamp3 on`
`set lamp on-for-timer 12`

Notes:

- Use reset with care: the device forgets even the housecode.
- As the FS20 protocol needs about 0.22 seconds to transmit a sequence, a pause of 0.22 seconds is inserted after each command.
- The FS20ST switches on for dim*%, dimup. It does not respond to sendstate.
- If the timer is set (i.e. it is not 0) then on, dim*, and *-for-timer will take it into account (at least by the FS20ST).
- The `time` argument ranges from 0.25sec to 4 hours and 16 minutes. As the time is encoded in one byte there are only 112 distinct values, the resolution gets coarse with larger values. The program will report the used timeout if the specified one cannot be set exactly. The resolution is 0.25 sec from 0 to 4 sec, 0.5 sec from 4 to 8 sec, 1 sec from 8 to 16 sec and so on. If you need better precision for large values, use at which has a 1 sec resolution.

Get

N/A

Attributes

- IODev
  Set the IO or physical device which should be used for sending signals for this "logical" device. An example for the physical device is an FHZ or a CUL. Note: Upon startup FHEM assigns each logical device (FS20/HMS/KS300/etc) the last physical device which can receive data for this type of device. The attribute IODev needs to be used only if you attached more than one physical device capable of receiving signals for this logical device.
- eventMap
  Replace event names and set arguments. The value of this attribute consists of a list of space separated values, each value is a colon separated pair. The first part specifies the "old" value, the second the new/desired value. If the first character is slash(/) or komma(,) then split not by space but by this character, enabling to embed spaces. Examples:
  `attr store eventMap on:open off:closed
  attr store eventMap /on-for-timer 10:open/off:closed/
  set store open`
- dummy
  Set the device attribute dummy to define devices which should not output any radio signals. Associated notifys will be executed if the signal is received. Used e.g. to react to a code from a sender, but it will not emit radio signal if triggered in the web frontend.
- follow-on-for-timer
  schedule a "setstate off;trigger off" for the time specified as argument to the on-for-timer command. Or the same with on, if the command is off-for-timer.
- follow-on-timer
  Like with follow-on-for-timer schedule a "setstate off;trigger off", but this time for the time specified as argument in seconds to this attribute. This is used to follow the pre-programmed timer, which was set previously with the timer command or manually by pressing the button on the device, see your manual for details. Works for on and dim commands.
- model
  The model attribute denotes the model type of the device. The attributes will (currently) not be used by the fhem.pl directly. It can be used by e.g. external programs or web interfaces to distinguish classes of devices and send the appropriate commands (e.g. "on" or "off" to a fs20st, "dim..%" to fs20du etc.). The spelling of the model names are as quoted on the printed documentation which comes which each device. This name is used without blanks in all lower-case letters. Valid characters should be `a-z 0-9` and `-` (dash), other characters should be ommited. Here is a list of "official" devices:
  Sender/Sensor: fs20fms fs20hgs fs20irl fs20kse fs20ls fs20pira fs20piri fs20piru fs20s16 fs20s20 fs20s4 fs20s4a fs20s4m fs20s4u fs20s4ub fs20s8 fs20s8m fs20sd fs20sn fs20sr fs20ss fs20str fs20tc1 fs20tc6 fs20tfk fs20tk fs20uts fs20ze fs20bf fs20si3
  Dimmer: fs20di fs20di10 fs20du
  Receiver/Actor: fs20as1 fs20as4 fs20ms2 fs20rgbsa fs20rst fs20rsu fs20sa fs20sig fs20sm4 fs20sm8 fs20st fs20su fs20sv fs20ue1 fs20usr fs20ws1
- ignore
  Ignore this device, e.g. if it belongs to your neighbour. The device won't trigger any FileLogs/notifys, issued commands will silently ignored (no RF signal will be sent out, just like for the dummy attribute). The device won't appear in the list command (only if it is explicitely asked for it), nor will it appear in commands which use some wildcard/attribute as name specifiers (see devspec). You still get them with the "ignored=1" special devspec.
- do_not_notify
- showtime
- readingFnAttributes

Generated events:

From an FS20 device you can receive one of the following events.
- on
- off
- toggle
- dimdown
- dimup
- dimupdown
- on-for-timer
Which event is sent is device dependent and can sometimes configured on the device.

### FTUISRV

Provides a mini HTTP server plugin for FHEMWEB for the specific use with FTUI. It serves files from a given directory and parses them according to specific rules. The goal is to be able to create reusable elements of multiple widgets and surrounding tags on multiple pages and even with different devices or other modifications. Therefore changes to the design have to be done only at one place and not at every occurence of the template (called parts in this doc). FTUISRV is an extension to FHEMWEB and code is based on HTTPSRV. You must install FHEMWEB to use FTUISRV. FTUISRV is able to handled includes and replacements in files before sending the result back to the client (Browser). Special handling of files is ONLY done if the filenames include the specific pattern ".ftui." in the filename. For example a file named "test.ftui.html" would be handled specifically in FTUISRV.
FTUI files can contain the following elements

- `<?ftui-inc="name" varname1="content1" ... varnameN="contentN" ?>`
  INCLUDE statement: Including other files that will be embedded in the result at the place of the include statement. Additionally in the embedded files the variables listed as varnamex will be replaced by the content enclosed in double quotes (").
  The quotation marks and the spaces between the variable replacements and before the final ? are significant and can not be ommitted.
  Example: `<?ftui-inc="temphum-inline.ftui.part" thdev="sensorWZ" thformat="top-space-2x" thtemp="measured-temp" ?>`
- `<?ftui-if=( expression ) ?> ... [ <?ftui-else ?> ... ] <?ftui-endif ?>`
  IF statement: Allow the inclusion of a block depending on an expression that might again include also variables and expressions in fhem. The else block is optional and can contain a block that is included if the expression is not evaluated to true.
  Example: `<?ftui-if=( [tempdevice:batteryok] ) ?> ... <?ftui-else ?> ... <?ftui-endif ?>`
- `<?ftui-loopinc="name" loopvariable=( loop-expression ) varname1="content1" ... varnameN="contentN" ?>`
  LOOP-INCLUDE statement: Including other files that will be embedded in the result at the place of the include statement. The include will be executed once for every entry (line) that is returned when evaluating the loop-expression as an fhem command. So the loop expression could be a list command returning multiple devices
  The quotation marks and the spaces between the variable replacements and before the final ? are significant and can not be ommitted.
  Example: `<?ftui-loopinc="temphum-inline.ftui.part" thdev=( list TYPE=CUL_TX ) thformat="top-space-2x" thtemp="measured-temp" ?>`
- `<?ftui-key=varname ?>`
  VARIABLE specification: Replacement of variables with given parameters in the include statement (or the include header). The text specified for the corresponding variable will be inserted at the place of the FTUI-Statement in parentheses. There will be no space or other padding added before or after the replacement, the replacement will be done exactly as specified in the definition in the include
  Example: `<?ftui-key=measured-temp ?>`
- `<?ftui-header="include name" varname1[="defaultcontent1"] .. varnameN[="defaultcontentN"] ?>`
  HEADER definition: Optional header for included files that can be used also to specify which variables are used in the include file and optionally specify default content for the variables that will be used if no content is specified in the include statement. the header is removed from the output given by FTUISRV. Headers are only required if default values should be specified and are helpful in showing the necessary variable names easy for users. (The name for the include does not need to be matching the file name)
  Example: `<?ftui-header="TempHum inline" thdev thformat thtemp="temperature" ?>` Headers can also use device readings in for setting default values in the form of `[device:reading]`(according to the syntax and logic used in the set command)
  Example: `<?ftui-header="TempHum inline" thdev thformat thbattery=[temphm:batteryok] thtemp="temperature" ?>`
  In the special case, where also variable content shall be used in the header part a special escaping for the closing tags for the ftui-key needs to be used. That means for the example above: Example: `<?ftui-header="TempHum inline" thdev thformat thbattery=[<ftui-key=thdev ?\>:batteryok] thtemp="temperature" ?>`

Define

`define <name> <infix> <directory> <friendlyname>`
Defines the HTTP server. `<infix>` is the portion behind the FHEMWEB base URL (usually `http://hostname:8083/fhem`), `<directory>` is the absolute path the files are served from, and `<friendlyname>` is the name displayed in the side menu of FHEMWEB.

Set

n/a

Attributes

- `validateFiles <0,1,2>`
  Allows basic validation of HTML/Part files on correct opening/closing tags etc. Here the original files from disk are validated (setting to 1 means validation is done / 2 means also the full parsing is logged (Attention very verbose !)
- `validateResult <0,1,2>`
  Allows basic validation of HTML content on correct opening/closing tags etc. Here the resulting content provided to the browser (after parsing) are validated (setting to 1 means validation is done / 2 means also the full parsing is logged (Attention very verbose !)
- `templateFiles <relative paths separated by :>`
  specify specific files / urls to be handled as templates even if not containing the ftui in the filename. Multiple files can be separated by colon.

### FileLog

Define

`define <name> FileLog <filename> <regexp> [readonly]`
Log events to `<filename>`. The log format is

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

The regexp will be checked against the device name devicename:event or timestamp:devicename:event combination. The regexp must match the complete string, not just a part of it.
`<filename>` may contain %-wildcards of the POSIX strftime function of the underlying OS (see your strftime manual). Common used 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)

FHEM also replaces `%L` by the value of the global logdir attribute.
Before using `%V` for ISO 8601 week numbers check if it is correctly supported by your system (%V may not be replaced, replaced by an empty string or by an incorrect ISO-8601 week number, especially at the beginning of the year) If you use `%V` you will also have to use %G instead of %Y for the year!
If readonly is specified, then the file is used only for visualisation, and it is not opened for writing. Examples:

`define lamplog FileLog %L/lamp.log lamp`
`define wzlog FileLog ./log/wz-%Y-%U.log wz:(measured-temp|actuator).*`
With ISO 8601 week numbers, if supported:
`define wzlog FileLog ./log/wz-%G-%V.log wz:(measured-temp|actuator).*`

Set

- reopen
  Reopen a FileLog after making some manual changes to the logfile.
- clear
  Clears and reopens the logfile.
- addRegexpPart <device> <regexp>
  add a regexp part, which is constructed as device:regexp. The parts are separated by |. Note: as the regexp parts are resorted, manually constructed regexps may become invalid.
- removeRegexpPart <re>
  remove a regexp part. Note: as the regexp parts are resorted, manually constructed regexps may become invalid.
  The inconsistency in addRegexpPart/removeRegexPart arguments originates from the reusage of javascript functions.
- absorb secondFileLog
  merge the current and secondFileLog into one file, add the regexp of the secondFileLog to the current one, and delete secondFileLog.
  This command is needed to create combined plots (weblinks).
  Notes:
  - secondFileLog will be deleted (i.e. the FHEM definition).
  - only the current files will be merged.
  - weblinks using secondFilelog will become broken, they have to be adopted to the new logfile or deleted.

Get

`get <name> <infile> <outfile> <from> <to> <column_spec>`
Read data from the logfile, used by frontends to plot data without direct access to the file.

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

Example:

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

Attributes

- addStateEvent
- archivecmd / archivedir / nrarchive
  When a new FileLog file is opened, the FileLog archiver wil be called. This happens only, if the name of the logfile has changed (due to time-specific wildcards, see the FileLog section), and there is a new entry to be written into the file.
  If the attribute archivecmd is specified, then it will be started as a shell command (no enclosing " is needed), and each % in the command will be replaced with the name of the old logfile.
  If this attribute is not set, but nrarchive is set, then nrarchive old logfiles are kept along the current one while older ones are moved to archivedir (or deleted if archivedir is not set).
  Note: "old" means here the first ones in the alphabetically soreted list.
  Note: setting these attributes for the global instance will effect the FHEM logfile only.
- archiveCompress
  If nrarchive, archivedir and archiveCompress is set, then the files in the archivedir will be compressed.
- createGluedFile
  If set (to 1), and the SVG-Plot requests a time-range wich is stored in two files, a temporary file with the content of both files will be created, in order to satisfy the request.
- disable
- disabledForIntervals
- eventOnThreshold
  If set (to a nonzero number), the event linesInTheFile will be generated, if the lines in the file is a multiple of the set number. Note: the counter is only correct for files created after this feature was implemented. A FHEM crash or kill will falsify the counter.
- logtype
  Used by the pgm2 webfrontend to offer gnuplot/SVG images made from the logs. The string is made up of tokens separated by comma (,), each token specifies a different gnuplot program. The token may contain a colon (:), the part before the colon defines the name of the program, the part after is the string displayed in the web frontend. Currently following types of gnuplot programs are implemented:
  - fs20
    Plots on as 1 and off as 0. The corresponding filelog definition for the device fs20dev is:
    define fslog FileLog log/fs20dev-%Y-%U.log fs20dev
  - fht
    Plots the measured-temp/desired-temp/actuator lines. The corresponding filelog definitions (for the FHT device named fht1) looks like:
    `define fhtlog1 FileLog log/fht1-%Y-%U.log fht1:.*(temp|actuator).*`
  - temp4rain10
    Plots the temperature and rain (per hour and per day) of a ks300. The corresponding filelog definitions (for the KS300 device named ks300) looks like:
    define ks300log FileLog log/fht1-%Y-%U.log ks300:.*H:.*
  - hum6wind8
    Plots the humidity and wind values of a ks300. The corresponding filelog definition is the same as above, both programs evaluate the same log.
  - text
    Shows the logfile as it is (plain text). Not gnuplot definition is needed.
  Example:
  attr ks300log1 logtype temp4rain10:Temp/Rain,hum6wind8:Hum/Wind,text:Raw-data
- mseclog
- reformatFn
  used to convert "foreign" logfiles for the SVG Module, contains the name(!) of a function, which will be called with a "raw" line from the original file, and has to return a line in "FileLog" format.
  E.g. to visualize the NTP loopstats, set reformatFn to ntpLoopstats, and copy the following into your 99_myUtils.pm:

            sub
            ntpLoopstats($)
            {
              my ($d) = @_;
              return $d if($d !~ m/^(\d{5}) (\d+)\.(\d{3}) (.*)$/);
              my ($r, $t) = ($4, FmtDateTime(($1-40587)*86400+$2));
              $t =~ s/ /_/;
              return "$t ntpLoopStats $r";
            }

### GAEBUS

The GAEBUS module is the representation of a Ebus connector in FHEM. The GAEBUS module is designed to connect to ebusd (ebus daemon) via a socket connection (default is port 8888)

Define

`define <name> GAEBUS <device-addr>[:<port>] [<interval>];`
<device-addr>[:<port>] specifies the host:port of the ebusd device. E.g. 192.168.0.244:8888 or servername:8888. When using the standard port, the port can be omitted.
Example:
`define ebus1 GAEBUS localhost 300`
When initializing the object no device specific commands are known. Please call "get ebusd_find" to read in supported commands from ebusd.
After fresh restart of ebusd it may take a while until all supported devices and their commands are visible.

Set

- reopen
  Will close and open the socket connection.
- [r]~<class> <variable-name>~<comment>
  Will define a attribute with the following syntax:
  [r]~<class>~<variable-name>~
  Valid combinations are read from ebusd (using "get ebusd_find") and are selectable.
  Values from the attributes will be used as the name for the reading which are read from ebusd in the interval specified.
  The content of <comment$gt; is dropped and not added to the attribute name.
- [w]~<class> <variable-name>~<comment>
  Will define a attribute with the following syntax:
  [w]~<class>~<variable-name>
  They will only appear if the attribute "ebusWritesEnabled" is set to "1"
  Valid combinations are read from ebusd (using "get ebusd_find") and are selectable.
  Values from the attributes will be used for set commands to modify parameters for ebus devices
  Hint: if the values for the attributes are prefixed by "set-" then all possible parameters will be listed in one block
  The content of <comment$gt; is dropped and not added to the attribute name.

Get

- ebusd_info
  Execude info command on ebusd and show result.
- ebusd_find
  Execude find command on ebusd. Result will be used to display supported "set" and "get" commands.
- ebusd_hex
  Will pass the input value to the "hex" command of ebusd. See "ebusctl help hex" for valid parameters.
  This command is only available if "ebusWritesEnabled" is set to '1'.
- reading <reading-name>
  Will read the actual value form ebusd and update the reading.
- [r]~<class> <variable-name>~<comment>
  Will read this variable from the ebusd and show the result as a popup.
  Valid combinations are read from ebusd (using "get ebusd_find") and are selectable.
- removeCommentFromAttributeNames
  This will migrate the former used attribute names of format "[rw]~<class> <variable-name>~<comment>" into the format "[rw]~<class> <variable-name>".
  It is only available if such attributes are defined.

Attributes

- do_not_notify
- disable
- dummy
- showtime
- loglevel
- ebusWritesEnabled 0,1
  disable (0) or enable (1) that commands can be send to ebus devices
  See also description for Set and Get
  If Attribute is missing, default value is 0 (disable writes)
- Attributes of the format
  `[r]~<class>~<variable-name>`
  define variables that can be retrieved from the ebusd. They will appear when they are defined by a "set" command as described above.
  The value assigned to an attribute specifies the name of the reading for this variable.
  If ebusd returns a list of semicolon separated values then several semicolon separated readings can be defined.
  "dummy" is a placeholder for a reading that will be ignored. (e.g.: temperature;dummy;pressure).
  The name of the reading can be suffixed by "<:number>" which is a multiplicator for the evaluation within the specified interval. (eg. OutsideTemp:3 will evaluate this reading every 3-th cycle)
  All text followed the reading seperated by a blank is given as an additional parameter to ebusd. This can be used to request a single value if more than one is retrieved from ebus.
- Attributes of the format
  `[w]~<class>~<variable-name>`
  define parameters that can be changed on ebus devices (using the write command from ebusctl) They will appear when they are defined by a "set" command as described above.
  The value assigned to an attribute specifies the name that will be used in set to change a parameter for a ebus device.
- valueFormat
  Defines a map to format values within GAEBUS.
  All readings can be formated using syntax of sprinf. Values returned from ebusd are spearated by ";" and split before valueFormat is processed. This means more than one of the return values can be assigned to one reading.
  Example: { "temperature" => "%0.2f"; "from-to" => "%s-%s" }

### GEOFANCY

- Provides a webhook receiver for geofencing, e.g. via the following apps:
- Geofency (iOS)
- Locative (iOS)
- EgiGeoZone (Android)
- SMART Geofences (Windows 10, Windows 10 Mobile)

- Note: GEOFANCY is an extension to FHEMWEB. You need to install FHEMWEB to use GEOFANCY.

  Define
  `define <name> GEOFANCY <infix>`
  Defines the webhook server. `<infix>` is the portion behind the FHEMWEB base URL (usually `http://hostname:8083/fhem`)
  Example:
  `define geofancy GEOFANCY geo`
  The webhook will be reachable at http://hostname:8083/fhem/geo in that case.
  Set
  - clear readings can be used to cleanup auto-created readings from deprecated devices.
  Attributes
  - devAlias: Mandatory attribute to assign device name alias to an UUID in the format DEVICEUUID:Aliasname (most readings will only be created if devAlias was defined).
    Separate using blank to rename multiple device UUIDs.
    Should you be using GEOFANCY together with ROOMMATE or GUEST you might consider using attribute r*_geofenceUUIDs directly at those devices instead.
  Usage information / Hints on Security
  Likely your FHEM installation is not reachable directly from the internet (good idea!).
  It is recommended to have a reverse proxy like HAproxy, Pound or Varnish in front of FHEM where you can make sure access is only possible to a specific URI like /fhem/geo. Apache or Nginx might do as well. However, in case you have Apache or Nginx running already you should still consider one of the named reverse proxies in front of it for fine-grain security configuration.
  You might also want to think about protecting the access by using HTTP Basic Authentication and encryption via TLS/SSL. Using TLS offloading in the reverse proxy software is highly recommended and software like HAproxy provides high control of data flow for TLS.
  Also the definition of a dedicated FHEMWEB instance for that purpose together with allowed might help to restrict FHEM's functionality (e.g. set attributes allowedCommands and allowedDevices to ",". Note that attributes hiddengroup and hiddenroom of FHEMWEB do NOT protect from just guessing/knowing the correct URI but would help tremendously to prevent easy inspection of your FHEM setup.)
  To make that reverse proxy available from the internet, just forward the appropriate port via your internet router.
  The actual solution on how you can securely make your GEOFANCY webhook available to the internet is not part of this documentation and depends on your own skills.
  Integration with Home Automation
  You might want to have a look to the module family of ROOMMATE, GUEST and RESIDENTS for an easy processing of GEOFANCY events.

### GHoma

(en | de)

Connects fhem to an G-Homa adapter plug
ATTENTION!:
With an actual firmware and after firmware update, http access will be disabled.
Network parameters cannot changed anymore. The only way to use the plug again with FHEM is to change route DNS requests from G-Homa plug to plug.g-homa.com to your FHEM server.
preliminary:
- Configure WLAN settings:
  bring device in AP mode (press button for more than 3s, repeat this step until the LED is permanently on)
  Now connect with your computer to G-Home network.
  Browse to 10.10.100.254 (username:password = admin:admin)
  In STA Setting insert your WLAN settings
- Configure Network Parameters setting:
  Other Setting -> Protocol to TCP-Client
  Other Setting -> Port ID (remember value for FHEM settings)
  Other Setting -> Server Address (IP of your FHEM Server)
- Optional:
  Block all outgoing connections for G-Homa in your router.

Define

`define <name> GHoma <port>`
Specifies the GHoma server device.
New adapters will be added automaticaly after first connection.
You can also manyally add an adapter:
`define <name> GHoma <Id>`
where `Id` is the last 6 numbers of the plug's MAC address
Example: MAC= AC:CF:23:A5:E2:3B -> Id= A5E23B

Set

`set <name> <value>`
where `value` is one of:

`off
on
`

The set extensions are also supported.

Attributes

For plug devices:

- restoreOnStartup
  Restore switch state after reboot
  Default: last, valid values: last, on, off
- restoreOnReinit
  Restore switch state after reconnect
  Default: last, valid values: last, on, off
- blocklocal
  Restore switch state to reading state immideately after local switching
  Default: no, valid values: no, yes

For server devices:

- allowfrom
  Regexp of allowed ip-addresses or hostnames. If set, only connections from these addresses are allowed.

- readingFnAttributes

### GUEST

Define

`define <rg_GuestName> GUEST [<device name(s) of resident group(s)>]`
Provides a special virtual device to represent a guest of your home.
Based on the current state and other readings, you may trigger other actions within FHEM.
Used by superior module RESIDENTS but may also be used stand-alone.
Use comma separated list of resident device names for multi-membership (see example below).
Example:

`# Standalone
define rg_Guest GUEST
# Typical group member
define rg_Guest GUEST rgr_Residents # to be member of resident group rgr_Residents
# Member of multiple groups
define rg_Guest GUEST rgr_Residents,rgr_Guests # to be member of resident group rgr_Residents and rgr_Guests`

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

Set

`set <rg_GuestName> <command> [<parameter>]`
Currently, the following commands are defined.

- location - sets reading 'location'; see attribute rg_locations to adjust list shown in FHEMWEB
- mood - sets reading 'mood'; see attribute rg_moods to adjust list shown in FHEMWEB
- state home,gotosleep,asleep,awoken,absent,none switch between states; see attribute rg_states to adjust list shown in FHEMWEB
- create
- locationMap add a pre-configured weblink device using showing a Google Map if readings locationLat+locationLong are present.
- wakeuptimer add several pre-configurations provided by RESIDENTS Toolkit. See separate section in RESIDENTS module commandref for details.

Note: If you would like to restrict access to admin set-commands (-> create) 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.

Possible states and their meaning

This module differs between 6 states:

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

Presence correlation to location

Under specific circumstances, changing state will automatically change reading 'location' as well.
Whenever presence state changes from 'absent' to 'present', the location is set to 'home'. If attribute rg_locationHome was defined, first location from it will be used as home location.
Whenever presence state changes from 'present' to 'absent', the location is set to 'underway'. If attribute rg_locationUnderway was defined, first location from it will be used as underway location.

Auto Gone

Whenever an individual is set to 'absent', a trigger is started to automatically change state to 'gone' after a specific timeframe.
Default value is 16 hours.
This behaviour can be customized by attribute rg_autoGoneAfter.

Synchronizing presence with other ROOMMATE or GUEST devices

If you always leave or arrive at your house together with other roommates or guests, you may enable a synchronization of your presence state for certain individuals.
By setting attribute rg_passPresenceTo, those individuals will follow your presence state changes to 'home', 'absent' or 'gone' as you do them with your own device.
Please note that individuals with current state 'none' or 'gone' (in case of roommates) will not be touched.

Location correlation to state

Under specific circumstances, changing location will have an effect on the actual state as well.
Whenever location is set to 'home', the state is set to 'home' if prior presence state was 'absent'. If attribute rg_locationHome was defined, all of those locations will trigger state change to 'home' as well.
Whenever location is set to 'underway', the state is set to 'absent' if prior presence state was 'present'. If attribute rg_locationUnderway was defined, all of those locations will trigger state change to 'absent' as well. Those locations won't appear in reading 'lastLocation'.
Whenever location is set to 'wayhome', the reading 'wayhome' is set to '1' if current presence state is 'absent'. If attribute rg_locationWayhome was defined, LEAVING one of those locations will set reading 'wayhome' to '1' as well. So you actually have implicit and explicit options to trigger wayhome.
Arriving at home will reset the value of 'wayhome' to '0'.
If you are using the GEOFANCY module, you can easily have your location updated with GEOFANCY events by defining a simple NOTIFY-trigger like this:
`define n_rg_Guest.location notify geofancy:currLoc_Guest.* set rg_Guest:FILTER=location!=$EVTPART1 location $EVTPART1`
By defining geofencing zones called 'home' and 'wayhome' in the iOS app, you automatically get all the features of automatic state changes described above.

Attributes

- rg_autoGoneAfter - hours after which state should be auto-set to 'gone' when current state is 'absent'; defaults to 16 hours
- rg_geofenceUUIDs - comma separated list of device UUIDs updating their location via GEOFANCY. Avoids necessity for additional notify/DOIF/watchdog devices and can make GEOFANCY attribute devAlias obsolete. (using more than one UUID/device might not be a good idea as location my leap)
- rg_locationHome - locations matching these will be treated as being at home; first entry reflects default value to be used with state correlation; separate entries by space; defaults to 'home'
- rg_locationUnderway - locations matching these will be treated as being underway; first entry reflects default value to be used with state correlation; separate entries by comma or space; defaults to "underway"
- rg_locationWayhome - leaving a location matching these will set reading wayhome to 1; separate entries by space; defaults to "wayhome"
- rg_locations - list of locations to be shown in FHEMWEB; separate entries by comma only and do NOT use spaces
- rg_moodDefault - the mood that should be set after arriving at home or changing state from awoken to home
- rg_moodSleepy - the mood that should be set if state was changed to gotosleep or awoken
- rg_moods - list of moods to be shown in FHEMWEB; separate entries by comma only and do NOT use spaces
- rg_noDuration - may be used to disable duration timer calculation (see readings durTimer*)
- rg_passPresenceTo - synchronize presence state with other GUEST or GUEST devices; separte devices by space
- rg_presenceDevices - take over presence state from any other FHEM device. Separate more than one device with comma meaning ALL of them need to be either present or absent to trigger update of this ROOMMATE device.
- rg_realname - whenever GUEST wants to use the realname it uses the value of attribute alias or group; defaults to group
- rg_showAllStates - states 'asleep' and 'awoken' are hidden by default to allow simple gotosleep process via devStateIcon; defaults to 0
- rg_states - list of states to be shown in FHEMWEB; separate entries by comma only and do NOT use spaces; unsupported states will lead to errors though
- rg_wakeupDevice - reference to enslaved DUMMY devices used as a wake-up timer (part of RESIDENTS Toolkit's wakeuptimer)

Generated Readings/Events:

- durTimerAbsence - timer to show the duration of absence from home in human readable format (hours:minutes:seconds)
- durTimerAbsence_cr - timer to show the duration of absence from home in computer readable format (minutes)
- durTimerPresence - timer to show the duration of presence at home in human readable format (hours:minutes:seconds)
- durTimerPresence_cr - timer to show the duration of presence at home in computer readable format (minutes)
- durTimerSleep - timer to show the duration of sleep in human readable format (hours:minutes:seconds)
- durTimerSleep_cr - timer to show the duration of sleep in computer readable format (minutes)
- lastArrival - timestamp of last arrival at home
- lastAwake - timestamp of last sleep cycle end
- lastDeparture - timestamp of last departure from home
- lastDurAbsence - duration of last absence from home in human readable format (hours:minutes:seconds)
- lastDurAbsence_cr - duration of last absence from home in computer readable format (minutes)
- lastDurPresence - duration of last presence at home in human readable format (hours:minutes:seconds)
- lastDurPresence_cr - duration of last presence at home in computer readable format (minutes)
- lastDurSleep - duration of last sleep in human readable format (hours:minutes:seconds)
- lastDurSleep_cr - duration of last sleep in computer readable format (minutes)
- lastLocation - the prior location
- lastMood - the prior mood
- lastSleep - timestamp of last sleep cycle begin
- lastState - the prior state
- lastWakeup - time of last wake-up timer run
- lastWakeupDev - device name of last wake-up timer
- location - the current location
- mood - the current mood
- nextWakeup - time of next wake-up program run
- nextWakeupDev - device name for next wake-up program run
- presence - reflects the home presence state, depending on value of reading 'state' (can be 'present' or 'absent')
- state - reflects the current state
- wakeup - becomes '1' while a wake-up program of this resident is being executed
- wayhome - depending on current location, it can become '1' if individual is on his/her way back home
- The following readings will be set to '-' if state was changed to 'none':
  lastArrival, lastDurAbsence, lastLocation, lastMood, location, mood

### GasCalculator

The GasCalculator Module calculates the gas consumption and costs of one ore more gas counters.
It is not a counter module itself but requires a regular expression (regex or regexp) in order to know where retrieve the counting ticks of one or more mechanical gas counter.
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 GasCalculator module provides several current, historical, statistical predictable values around with respect to one or more gas-counter and creates respective readings.
To avoid waiting for max. 12 months to have realistic values, the readings `<DestinationDevice>_<SourceCounterReading>_Vol1stDay`, `<DestinationDevice>_<SourceCounterReading>_Vol1stMonth`, `<DestinationDevice>_<SourceCounterReading>_Vol1stYear` and `<DestinationDevice>_<SourceCounterReading>_Vol1stMeter` must be corrected with real values by using the `setreading` - command. These real values may be found on the last gas 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.

Define

`define <name> GasCalculator <regex>`

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

Example: `define myGasCalculator GasCalculator myGasCounter: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 GasCalculator 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 gas supply to the home.
The value is provided by your local gas provider is shown on your gas bill.
For UK 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.

- `GasCounterOffset` :

A valid float number of the volume difference = offset (not the difference of the counter ticks!) between the value shown on the mechanic meter for the gas volume and the calculated volume of this device.
The value for this offset will be calculated as follows VOffset = VMechanical - VModule
The default value is 0.00

- `GasCubicPerCounts` :

A valid float number of the ammount of volume per ticks.
The value is given by the mechanical trigger of the mechanical gas meter. E.g. GasCubicPerCounts = 0.01 means each count is a hundredth of the volume basis unit.
The default value is 0.01

- `GasNominalHeatingValue` :

A valid float number for the gas heating value in [kWh/ chosen Volume].
The value is provided by your local gas provider is shown on your gas bill.
The default value is 10.00

- `GaszValue` :

A valid float number for the gas condition based on the local installation of the mechanical gas meter in relation of the gas providers main supply station.
The value is provided by your local gas provider is shown on your gas bill.
The default value is 1.00

- `GasPricePerKWh` :

A valid float number for gas price in the chosen currency per kWh for the gas.
The value is provided by your local gas provider is shown on your gas bill.
The default value is 0.0654

- `MonthlyPayment` :

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

- `MonthOfAnnualReading` :

A valid integer number for the month when the mechanical gas 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 gas-meter.
The default value is CalculatorDevice - Therefore the readings will be written into this device.

- `Volume` :

One of the pre-defined list of volume symbols [m³,ft³].
The default value is m³

Readings

As soon the device has been able to read at least 2 times the counter, it automatically will create a set 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.

- `<DestinationDevice>_<SourceCounterReading>_EnergyCostDayLast` :

Energy costs of the last day.

- `<DestinationDevice>_<SourceCounterReading>_EnergyCostMeter` :

Energy costs in the chosen currency since the beginning of the month of where the last gas-meter reading has been performed by the gas supplier.

- `<DestinationDevice>_<SourceCounterReading>_EnergyCostMeterLast` :

Energy costs in the chosen currency of the last gas-meter period.

- `<DestinationDevice>_<SourceCounterReading>_EnergyCostMonth` :

Energy costs in the chosen currency since the beginning of the current month.

- `<DestinationDevice>_<SourceCounterReading>_EnergyCostMonthLast` :

Energy costs in the chosen currency of the last month.

- `<DestinationDevice>_<SourceCounterReading>_EnergyCostYear` :

Energy costs in the chosen currency since the beginning of the current year.

- `<DestinationDevice>_<SourceCounterReading>_EnergyCostYearLast` :

Energy costs of the last calendar 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 gas-meter reading has been performed by the gas supplier.

- `<DestinationDevice>_<SourceCounterReading>_EnergyMeterLast` :

Total Energy consumption in kWh of the last gas-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 Reserver based on the advanced payments done on the first of every month towards the gas supplier. With negative values, an additional payment is to be excpected.

- `<DestinationDevice>_<SourceCounterReading>_MonthMeterReading` :

Number of month since last meter reading. The month when the reading occured is the first month = 1.

- `<DestinationDevice>_<SourceCounterReading>_Meter` :

Current indicated total volume consumption on mechanical gas meter. Correct Offset-attribute if not identical.

- `<DestinationDevice>_<SourceCounterReading>_PowerCurrent` :

Current heating Power. (Average between current and previous measurement.)

- `<DestinationDevice>_<SourceCounterReading>_PowerDayAver` :

Average heating Power since midnight.

- `<DestinationDevice>_<SourceCounterReading>_PowerDayMax` :

Maximum power peak since midnight.

- `<DestinationDevice>_<SourceCounterReading>_PowerDayMin` :

Minimum power peak since midnight.

- `<DestinationDevice>_<SourceCounterReading>_Vol1stDay` :

First volume reading of the current day.

- `<DestinationDevice>_<SourceCounterReading>_VolLastDay` :

Volume reading of the previous day.

- `<DestinationDevice>_<SourceCounterReading>_Vol1stMonth` :

First volume reading of the current month.

- `<DestinationDevice>_<SourceCounterReading>_VolLastMonth` :

Volume reading of the previous month.

- `<DestinationDevice>_<SourceCounterReading>_Vol1stYear` :

First volume reading of the current year.

- `<DestinationDevice>_<SourceCounterReading>_VolLastYear` :

Volume reading of the previous year.

- `<DestinationDevice>_<SourceCounterReading>_Vol1stMeter` :

First volume reading of the first day of the month of the current meter reading period.

- `<DestinationDevice>_<SourceCounterReading>_VolLastMeter` :

Volume reading of the first day of the month of the last meter reading period.

### GoogleAuth

GoogleAuthenticator provides two-factor-authentication using one-time-passwords (token).
These tokens are generated using the mobile app „Google Authenticator“ for example on a smartphone.
See https://en.wikipedia.org/wiki/Google_Authenticator for more informations.
Prerequesits
- The fhem implementation of the Google Authenticator is credited to the following publication:
  https://blog.darkpan.com/article/6/Perl-and-Google-Authenticator.html
- Module uses following additional Perl modules:
  `Convert::Base32 Authen::OATH Crypt::URandom`
  If not already installed in your environment, please install them using appropriate commands from your environment.
  Package installation in debian environments:
  `apt-get install libconvert-base32-perl libauthen-oath-perl libcrypt-urandom-perl`
Define

`define <name> GoogleAuth`
Example:

`define googleAuth GoogleAuth`

Set Commands

- `set <name> new`
  Generates a new secret key and displays the corresponding QR image.
  Using the photo function of the Google Authenticator app,
  this QR image can be used to transfer the secret key to the app.
- `set <name> revoke`
  Remove existing key.
  You can not create a new key before an existing key was deleted.

Get Commands

- `get <name> check <token>`
  Check the validity of a given token; return value is 1 for a valid token, otherwise -1.
  - Token always consists of six numerical digits and will change every 30 seconds.
  - Token is valid if it matches one of three tokens calculated by FHEM
    using three timestamps: -30 seconds, now and +30 seconds.
    This behavior can be changed by attribute ga_strictCheck.
- `gAuth(<name>,<token>)`
  For easy use in your own functions you can call function gAuth(),
  which will return same result codes as the "get" command.

Attributes

- ga_labelName - define a Name to identify PassCode inside the app.
  Do not use any special characters, except SPACE, in this attribute!
- ga_qrSize - select image size of qr code
- ga_showKey - show key for manual use if set to 1
- ga_showLink - show link to qr code if set to 1
- ga_showQR - show qr code if set to 1
- ga_strictCheck
  AttrVal = 1 : check given token against one token
  AttrVal = 0 : check given token against three tokens(default)

Generated Readings/Events

- lastResult - contains result from last token check
- state - "active" if a key is set, otherwise "defined"

### HCS

Defines a virtual device for monitoring thermostats (FHT, HM-CC-TC, MAX) to control a central heating unit.
Define

`define <name> HCS <device>`

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

The HCS (heating control system) device monitors the state of all detected thermostats in a free definable interval (by default: 10 min).
Regulation for heating requirement or suppression of the request can be controlled by valve position or measured temperature (default) using also free definable thresholds. In doing so, the HCS device also includes the hysteresis between two states.
Example for monitoring measured temperature:

Threshold temperature for heating requirement: 0.5 (default)
Threshold temperature for idle: 0.5 (default)
Heating is required when the measured temperature of a thermostat is lower than 0.5° Celsius as the desired temperature. HCS then activates the defined device until the measured temperature of the thermostat is 0.5° Celsius higher as the desired temperature (threshold for idle). In this example, both tresholds are equal.

Example for monitoring valve position:

Threshold valve position for heating requirement: 40% (default)
Threshold valve position for idle: 35% (default)
Heating is required when the "open" position of a valve is more than 40%. HCS then activates the defined device until the "open" position of the valve has lowered to 35% or less (threshold for idle).

The HCS device supports an optional eco mode. The threshold oriented regulation by measured temperature or valve position can be overridden by setting economic thresholds.
Example:

Threshold temperature economic mode on: 15° Celsius
Threshold temperature economic mode off: 25° Celsius
HCS activates the defined device until the measured temperature of one ore more thermostats is lower or equal than 15° Celsius. If a measured temperature of one or more thermostats is higher or equal than 25° Celsius, HCS switch of the defined device (if none of the measured temperatures of all thermostats is lower or equal as 15° Celsius).

In addition, the HCS device supports an optional temp-sensor. The threshold and economic oriented regulation can be overriden by the reading of the temp-sensor (overdrive mode).
Example:

Threshold temperature reading for heating requirement: 10° Celsius
Threshold temperature reading for idle: 18° Celsius
Is a measured temperature ore valve position reaching or exceeding the threshold for heating requirement, but the temperature reading is more than 18° Celcius, the selected device will stay deactivated. The measured temperature or valve-position oriented regulation has been overridden by the temperature reading in this example.

The HCS device automatically detects devices which are ignored. Furthermore, certain devices can also be excluded of the monitoring manually.
To reduce the transmission load, use the attribute event-on-change-reading, e.g. `attr <name> event-on-change-reading state,devicestate,eco,overdrive`
To avoid frequent switching "on" and "off" of the device, a timeout (in minutes) can be set using the attribute `idleperiod`.
Get

- `values`
  returns the actual values of each device

Set

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

Attributes

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

### HEATRONIC

The HEATRONIC module interprets messages received from the HT-Bus of a Junkers Boiler.
Possible Adapters are described in http://www.mikrocontroller.net/topic/317004 (only in german).
Define:

`define <name> HEATRONIC <serial-device | <proxy-server IP-address:port>` Example for serial-device:

`define Boiler HEATRONIC /dev/ttyUSB0@9600`

Example for proxy-server:

`define Boiler HEATRONIC 192.168.2.11:8088`

Set:

`set <name> <param> <value>`

(only possible with ht_pitiny- or ht_piduino-adapters)

where param is one of:

- hc1_Trequired <temp>
  sets the 'heating' temperature-niveau for heating circuit 1 (permanent)
  0.5 celsius resolution - temperature between 10 and 30 celsius
- hc1_mode [ auto | comfort | eco | frost ]
  sets the working mode for heating circuit 1
  - auto : the timer program is active and the summer configuration is in effect
  - comfort: manual by 'comfort' working mode, no timer program is in effect
  - eco : manual by 'eco' working mode, no timer program is in effect
  - frost : manual by 'frost' working mode, no timer program is in effect

Examples:

`set Boiler hc1_Trequired 22.5`
`set Boiler hc1_mode eco`

Attributes:

- interval_ch_time, interval_ch_Tflow_measured, interval_dhw_Tmeasured, interval_dhw_Tcylinder
  interval (in seconds) to update the corresponding values
- minDiff_ch_Tflow_measured
  minimal difference (in degrees, e.g. 0.2) to update the corresponding values

Readings:

- ch_Tflow_desired
  required flow temperature (in domestic hot water mode value of max vessel temperature)
- ch_Tflow_measured
  current measured flow temperature
- ch_Treturn
  current measured return temperature
- ch_Tmixer
  current measured mixer temperature
- ch_mode
  current operation mode (0=off, 1=heating, 2=domestic hot water)
- ch_code
  current operation code or extended error code (see manual of boiler)
- ch_code
  error code (see manual of boiler)
- ch_burner_fan
  status of burner fan (0=off, 1=running)
- ch_burner_operation
  burner status (0=off, 1=on)
- ch_pump_heating
  status of the heating pump(0=off, 1=running)
- ch_pump_cylinder
  status of cylinder loading pump (0=off, 1=running)
- ch_pump_circulation
  status of circulation pump (0=off, 1=running)
- ch_burner_power
  burner power in percent
- ch_pump_heating_power
  power of heating power in percent
- ch_Toutside
  outside temperature
- ch_runtime_total
  runtime of burner in minutes (heating and domestic hot water)
- ch_runtime_ch
  runtime of burner in minutes (heating only)
- ch_runtime_dhw
  runtime of burner in minutes (domestic hot water only)
- ch_starts_tot
  count of burner operations (heating and domestic hot water)
- ch_starts_ch
  count of burner operations (heating only)
- ch_starts_dhw
  count of burner operations (domestic hot water only)
- ch_time
  system time of boiler
- hc1_Tdesired .. hc4_Tdesired
  required room temperature for heating circuit 1-4
- hc1_Tmeasured .. hc4_Tmeasured
  current measured room temperature for heating circuit 1-4
- hc1_Tmode .. hc4_Tmode
  operating mode for heating circuit 1-4
- dhw_Tdesired
  required domestic hot water temperature
- dhw_Tmeasured
  current measured domestic hot water temperature
- dhw_Tcylinder
  current measured domestic hot water temperature at the top of the cylinder
- sol_Tcollector
  temperature of collector groupp 1
- sol_Tcylinder_bottom
  temperature at the bottom of solar cylinder
- sol_yield_last_hour
  yield of collector in the last hour
- sol_yield_2
  This value is unkown at the moment. The name can be changed later.
- sol_pump
  status of solar circuit pump (0=off, 1=running)
- sol_runtime
  runtime of solar pump in minutes

### HMCCU

The module provides an interface between FHEM and a Homematic CCU2. HMCCU is the I/O device for the client devices HMCCUDEV and HMCCUCHN. The module requires the additional Perl modules IO::File, RPC::XML::Client, RPC::XML::Server and SubProcess (part of FHEM). Define

`define <name> HMCCU <HostOrIP>`
Example:
`define myccu HMCCU 192.168.1.10`
The parameter HostOrIP is the hostname or IP address of a Homematic CCU2.
For automatic update of Homematic device datapoints and FHEM readings one have to:

- Define used RPC interfaces with attribute 'rpcinterfaces'
- Start RPC servers with command 'set rpcserver on'
- Optionally enable automatic start of RPC servers with attribute 'rpcserver'

Than start with the definition of client devices using modules HMCCUDEV (CCU devices) and HMCCUCHN (CCU channels).
Maybe it's helpful to set the following FHEM standard attributes for the HMCCU I/O device:

- Shortcut for RPC server control: eventMap /rpcserver on:on/rpcserver off:off/
- Show RPC server and I/O device state: stateFormat rpcstate/state

Set

- set <name> cleardefaults
  Clear default attributes imported from file.
- set <name> defaults
  Set default attributes for I/O device.
- set <name> execute <program>
  Execute a CCU program.
  Example:
  `set d_ccu execute PR-TEST`
- set <name> hmscript <script-file> [dump] [<parname>=<value> [...]]
  Execute Homematic script on CCU. If script code contains parameter in format $parname they are substituted by corresponding command line parameters parname.
  If output of script contains lines in format Object=Value readings in existing corresponding FHEM devices will be set. Object can be the name of a CCU system variable or a valid channel and datapoint specification. Readings for system variables are set in the I/O device. Datapoint related readings are set in client devices. If option 'dump' is specified the result of script execution is displayed in FHEM web interface.
- set <name> importdefaults <filename>
  Import default attributes from file.
- set <name> rpcserver {on | off | restart}
  Start, stop or restart RPC server(s). This command executed with option 'on' will fork a RPC server process for each RPC interface defined in attribute 'rpcinterfaces'. Until operation is completed only a few set/get commands are available and you may get the error message 'CCU busy'.
- set <name> var <variable> <Value> [...]
  Set CCU system variable value. Special characters \_ in value are substituted by blanks.

Get

- get <name> aggregation {<rule>|all}
  Process aggregation rule defined with attribute ccuaggregation.
- get <name> configdesc {<device>|<channel>}
  Get configuration parameter description of CCU device or channel (similar to device settings in CCU). Not every CCU device or channel provides a configuration parameter description. So result may be empty.
- get <name> defaults
  List device types and channels with default attributes available.
- get <name> deviceinfo <device-name> [{State | Value}]
  List device channels and datapoints. If option 'State' is specified the device is queried directly. Otherwise device information from CCU is listed.
- get <name> devicelist [dump]
  Read list of devices and channels from CCU. This command is executed automatically after the definition of an I/O device. It must be executed manually after module HMCCU is reloaded or after devices have changed in CCU (added, removed or renamed). With option 'dump' devices are displayed in browser window. If a RPC server is running HMCCU will raise events "count devices added in CCU" or "count devices deleted in CCU". It's recommended to set up a notification which reacts with execution of command 'get devicelist' on these events.
- get <name> devicelist create <devexp> [t={chn|dev|all}] [p=<prefix>] [s=<suffix>] [f=<format>] [defattr] [<attr>=<value> [...]]
  With option 'create' HMCCU will automatically create client devices for all CCU devices and channels matching specified regular expression. With option t=chn or t=dev (default) the creation of devices is limited to CCU channels or devices.
  Optionally a prefix and/or a suffix for the FHEM device name can be specified. The parameter format defines a template for the FHEM device names. Prefix, suffix and format can contain format identifiers which are substituted by corresponding values of the CCU device or channel: %n = CCU object name (channel or device), %d = CCU device name, %a = CCU address. In addition a list of default attributes for the created client devices can be specified. If option 'defattr' is specified HMCCU tries to set default attributes for device.
- get <name> dump {datapoints|devtypes} [<filter>]
  Dump all Homematic devicetypes or all devices including datapoints currently defined in FHEM.
- get <name> exportdefaults <filename>
  Export default attributes into file.
- get <name> parfile [<parfile>]
  Get values of all channels / datapoints specified in parfile. The parameter parfile can also be defined as an attribute. The file must contain one channel / datapoint definition per line. Datapoints are optional. The channel definition can be followed by a list of string substitution rules for datapoint values.
  The syntax of Parfile entries is:
  {[<interface>.]<channel-address>[.<datapoint-expr>] | <channel-name>[.<datapoint-expr>]} <regexp>:<subsstr>[,...]
  Empty lines or lines starting with a # are ignored.
- get <name> rpcstate
  Check if RPC server process is running.
- get <name> update [<devexp> [{State | Value}]]
  Update all datapoints / readings of client devices with FHEM device name(!) matching devexp. With option 'State' all CCU devices are queried directly. This can be time consuming.
- get <name> updateccu [<devexp> [{State | Value}]]
  Update all datapoints / readings of client devices with CCU device name(!) matching devexp. With option 'State' all CCU devices are queried directly. This can be time consuming.
- get <name> vars <regexp>
  Get CCU system variables matching regexp and store them as readings.

Attributes

- ccuackstate {0 | 1}
  If set to 1 state will be set to result of command (i.e. 'OK').
- ccuaggregate <rule>[;...]
  Define aggregation rules for client device readings. With an aggregation rule it's easy to detect if some or all client device readings are set to a specific value, i.e. detect all devices with low battery or detect all open windows.
  Aggregation rules are automatically executed as a reaction on reading events of HMCCU client devices. An aggregation rule consists of several parameters separated by comma:
  - name:<rule-name>
    Name of aggregation rule
  - filter:{name|alias|group|room|type}=<incl-expr>[!<excl-expr>]
    Filter criteria, i.e. "type=^HM-Sec-SC.*"
  - read:<read-expr>
    Expression for reading names, i.e. "STATE"
  - if:{any|all|min|max|sum|avg|lt|gt|le|ge}=<value>
    Condition, i.e. "any=open" or initial value, i.e. max=0
  - else:<value>
    Complementary value, i.e. "closed"
  - prefix:{<text>|RULE}
    Prefix for reading names with aggregation results
  - coll:{<attribute>|NAME}[!<default-text>]
    Attribute of matching devices stored in aggregation results. Default text in case of no matching devices found is optional.
  Aggregation results will be stored in readings prefixcount, prefix list, prefixmatch and prefixstate
  Example: Find open windows
  name=lock,filter:type=^HM-Sec-SC.*,read:STATE,if:any=open,else:closed,prefix:lock_,coll:NAME!All windows closed
  Example: Find devices with low batteries
  name=battery,filter:name=.*,read:(LOWBAT|LOW_BAT),if:any=yes,else:no,prefix:batt_,coll:NAME
- ccudef-hmstatevals <subst-rule[;...]>
  Set global rules for calculation of reading hmstate.
- ccudef-readingfilter <filter-rule[;...]>
  Set global reading/datapoint filter. This filter is added to the filter specified by client device attribute 'ccureadingfilter'.
- ccudef-readingformat {name | address | datapoint | namelc | addresslc | datapointlc}
  Set global reading format. This format is the default for all readings except readings of virtual device groups.
- ccudef-readingname <old-readingname-expr>:[+]<new-readingname> [;...]
  Set global rules for reading name substitution. These rules are added to the rules specified by client device attribute 'ccureadingname'.
- ccudef-substitute <subst-rule>[;...]
  Set global substitution rules for datapoint value. These rules are added to the rules specified by client device attribute 'substitute'.
- ccudefaults <filename>
  Load default attributes for HMCCUCHN and HMCCUDEV devices from specified file. Best practice for creating a custom default attribute file is by exporting predefined default attributes from HMCCU with command 'get exportdefaults'.
- ccuflags {extrpc, intrpc}
  Control RPC server process and datapoint validation:
  intrpc - Use internal RPC server instead of ccurpcd.pl. This is the default.
  extrpc - Use ccurpcd.pl instead of internal RPC server (depricated)
  dptnocheck - Do not check within set or get commands if datapoint is valid
- ccuget {State | Value}
  Set read access method for CCU channel datapoints. Method 'State' is slower than 'Value' because each request is sent to the device. With method 'Value' only CCU is queried. Default is 'Value'.
- ccureadingformat {name | address | datapoint | namelc | addresslc | datapointlc}
  Format of reading names (channel name, channel address or channel number combined with datapoint). With suffix 'lc' reading names are lowercase. Default is 'name'.
- ccureadings {0 | 1}
  If set to 1 values read from CCU will be stored as readings. Otherwise output is displayed in browser window.
- ccutrace {<ccu-devname-exp> | <ccu-address-exp>}
  Turn on trace mode for devices matching specified expression. Will write extended information into FHEM log (level 1). Deprecated. Use attribute 'ccuflags' in client devices instead.
- parfile <filename>
  Define parameter file for command 'get parfile'.
- rpcinterfaces <interface>[,...]
  Specify list of CCU RPC interfaces. HMCCU will register a RPC server for each interface. Valid interfaces are:
  - BidCos-Wired (Port 2000)
  - BidCos-RF (Port 2001)
  - Homegear (Port 2003)
  - HmIP (Port 2010)
  - VirtualDevice (Port 9292)
- rpcinterval <Seconds>
  Specifiy how often RPC queue is read. Default is 5 seconds.
- rpcport <value[,...]>
  Deprecated, use 'rpcinterfaces' instead. Specify list of RPC ports on CCU. Default is 2001. Valid RPC ports are:
  - 2000 = Wired components
  - 2001 = BidCos-RF (wireless 868 MHz components with BidCos protocol)
  - 2003 = Homegear (experimental)
  - 2010 = HM-IP (wireless 868 MHz components with IPv6 protocol)
  - 9292 = CCU group devices (especially heating groups)
- rpcqueue <queue-file>
  Specify name of RPC queue file. This parameter is only a prefix (including the pathname) for the queue files with extension .idx and .dat. Default is /tmp/ccuqueue. If FHEM is running on a SD card it's recommended that the queue files are placed on a RAM disk.
- rpcserver {on | off}
  Specify if RPC server is automatically started on FHEM startup.
- rpcserveraddr <ip-or-name>
  Specify network interface by IP address or DNS name where RPC server should listen on. By default HMCCU automatically detects the IP address. This attribute should be used if the FHEM server has more than one network interface.
- rpcserverport <base-port>
  Specify base port for RPC server. The real listening port of an RPC server is calculated by the formula: base-port + rpc-port + (10 * ccu-number). Default value for base-port is 5400.
  The value ccu-number is only relevant if more than one CCU is connected to FHEM. Example: If base-port is 5000, protocol is BidCos (rpc-port 2001) and only one CCU is connected the resulting RPC server port is 5000+2001+(10*0) = 7001.
- substitute <subst-rule>:<substext>[,...]
  Define substitions for datapoint values. Syntax of subst-rule is
  [[<channelno.>]<datapoint>[,...]!]<{#n1-m1|regexp1}>:<text1>[,...]
  Substitutions for parfile values must be specified in parfiles.
- stripchar <character>
  Strip the specified character from variable or device name in set commands. This is useful if a variable should be set in CCU using the reading with trailing colon.

### HMCCUCHN

The module implements Homematic CCU channels as client devices for HMCCU. A HMCCU I/O device must exist before a client device can be defined. If a CCU channel is not found execute command 'get devicelist' in I/O device. Define

`define <name> HMCCUCHN {<channel-name> | <channel-address>} [readonly] [defaults] [iodev=<iodev-name>]`
If option 'readonly' is specified no set command will be available. With option 'defaults' some default attributes depending on CCU device type will be set. Default attributes are only available for some device types.
The define command accepts a CCU2 channel name or channel address as parameter.
Examples:
`define window_living HMCCUCHN WIN-LIV-1 readonly`
`define temp_control HMCCUCHN BidCos-RF.LEQ1234567:1`
The interface part of a channel address must not be specified. The default is 'BidCos-RF'. Channel addresses can be found with command 'get deviceinfo <devicename>' executed in I/O device.

Set

- set <name> clear [<reading-exp>]
  Delete readings matching specified reading name expression. Default expression is '.*'. Readings 'state' and 'control' are not deleted.
- set <name> config [device] [<rpcport>] <parameter>=<value>] [...]
  Set config parameters of CCU channel. This is equal to setting device parameters in CCU. Valid parameters can be listed by using commands 'get configdesc' or 'get configlist'. With option 'device' specified parameters are set in device instead of channel.
- set <name> datapoint <datapoint> <value>
  Set value of a datapoint of a CCU channel. If parameter value contains special character \_ it's substituted by blank.
  Examples:
  `set temp_control datapoint SET_TEMPERATURE 21`
- set <name> defaults
  Set default attributes for CCU device type. Default attributes are only available for some device types and for some channels of a device type.
- set <name> devstate <value>
  Set state of a CCU device channel. The state datapoint of a channel must be defined by setting attribute 'statedatapoint' to a valid datapoint name.
  Example:
  `set light_entrance devstate true`
- set <name> <statevalue>
  Set state of a CCU device channel to StateValue. The state datapoint of a channel must be defined by setting attribute 'statedatapoint'. The available state values must be defined by setting attribute 'statevals'.
  Example: Turn switch on
  `attr myswitch statedatapoint STATE
  attr myswitch statevals on:true,off:false
  set myswitch on`
- set <name> toggle
  Toggle state datapoint between values defined by attribute 'statevals'. This command is only available if attribute 'statevals' is set. Toggling supports more than two state values.
  Example: Toggle blind actor
  `attr myswitch statedatapoint LEVEL
  attr myswitch statevals up:100,down:0
  set myswitch toggle`
- set <name> on-for-timer <ontime>
  Switch device on for specified number of seconds. This command is only available if channel contains a datapoint ON_TIME. The attribute 'statevals' must contain at least a value for 'on'. The attribute 'statedatapoint' must be set to a writeable datapoint.
  Example: Turn switch on for 300 seconds
  `attr myswitch statedatapoint STATE
  attr myswitch statevals on:true,off:false
  set myswitch on-for-timer 300`
- set <name> on-till <timestamp>
  Switch device on until timestamp. Parameter timestamp can be a time in format HH:MM or HH:MM:SS. This command is only available if channel contains a datapoint ON_TIME. The attribute 'statevals' must contain at least a value for 'on'. The Attribute 'statedatapoint' must be set to a writeable datapoint.
- set <name> pct <value> [<ontime> [<ramptime>]]
  Set datapoint LEVEL of a channel to the specified value. Optionally a ontime and a ramptime (both in seconds) can be specified. This command is only available if channel contains at least a datapoint LEVEL and optionally datapoints ON_TIME and RAMP_TIME. The parameter ontime can be specified in seconds or as timestamp in format HH:MM or HH:MM:SS. If ontime is 0 it's ignored. This syntax can be used to modify the ramp time only.
  Example: Turn dimmer on for 600 second. Increase light to 100% over 10 seconds
  `attr myswitch statedatapoint LEVEL
  attr myswitch statevals on:100,off:0
  set myswitch pct 100 600 10`

Get

- get <name> config [device] [<filter-expr>]
  Get configuration parameters of CCU channel. If attribute 'ccureadings' is 0 results are displayed in browser window. Parameters can be filtered by filter-expr. Parameters to be stored as readings must be part of 'ccureadingfilter'. If option 'device' is specified parameters of device are read.
- get <name> configdesc [device]
  Get description of configuration parameters of CCU channel or device if option 'device' is specified.
- get <name> configlist [device] [<filter-expr>]
  Get configuration parameters of CCU channel. Parameters can be filtered by filter-expr. With option 'device' device parameters are listed.
- get <name> datapoint <datapoint>
  Get value of a CCU channel datapoint.
- get <name> defaults
  Display default attributes for CCU device type.
- get <name> deviceinfo [{State | Value}]
  Display all channels and datapoints of device with datapoint values and types.
- get <name> devstate
  Get state of CCU device. Default datapoint STATE can be changed by setting attribute 'statedatapoint'. Command will fail if state datapoint does not exist in channel.
- get <name> update [{State | Value}]
  Update all datapoints / readings of channel. With option 'State' the device is queried. This request method is more accurate but slower then 'Value'.

Attributes

To reduce the amount of events it's recommended to set attribute 'event-on-change-reading' to '.*'.
- ccuackstate {0 | 1}
  If set to 1 state will be set to result of command (i.e. 'OK'). Otherwise state is only updated if value of state datapoint has changed.
- ccucalculate <value>:<reading>[:<dp-list>[;...]
  Calculate special values like dewpoint based on datapoints specified in dp-list. The result is stored in reading. The following values are supported:
  dewpoint = calculate dewpoint, dp-list = <temperature>,<humidity>
- ccuflags {nochn0, trace}
  Control behaviour of device:
  nochn0: Prevent update of status channel 0 datapoints / readings.
  trace: Write log file information for operations related to this device.
- ccuget {State | Value}
  Set read access method for CCU channel datapoints. Method 'State' is slower than 'Value' because each request is sent to the device. With method 'Value' only CCU is queried. Default is 'Value'.
- ccureadings {0 | 1}
  If set to 1 values read from CCU will be stored as readings. Default is 1.
- ccureadingfilter <filter-rule[;...]>
  Only datapoints matching specified expression are stored as readings.
  Syntax for filter-rule is: [N:][<channel-name>!]<RegExp>
  If channel-name is specified the following rule applies only to this channel. By default all datapoints will be stored as readings. Attribute ccudef-readingfilter of I/O device will be checked before this attribute.
  If a rule starts with 'N:' the filter is negated which means that a reading is stored if rule doesn't match.
- ccureadingformat {address[lc] | name[lc] | datapoint[lc]}
  Set format of reading names. Default is 'name'. If set to 'address' format of reading names is channel-address.datapoint. If set to 'name' format of reading names is channel-name.datapoint. If set to 'datapoint' format is channel-number.datapoint. With suffix 'lc' reading names are converted to lowercase.
- ccureadingname <old-readingname-expr>:[+]<new-readingname>[;...]
  Set alternative or additional reading names or group readings. Only part of old reading name matching old-readingname-exptr is substituted by new-readingname. If new-readingname is preceded by '+' an additional reading is created. If old-readingname-expr matches more than one reading the values of these readings are stored in one reading. This makes sense only in some cases, i.e. if a device has several pressed_short datapoints and a reading should contain a value if any button is pressed.
  Examples:
  `# Rename readings 0.LOWBAT and 0.LOW_BAT as battery
  attr mydev ccureadingname 0.(LOWBAT|LOW_BAT):battery
  # Add reading battery as a copy of readings LOWBAT and LOW_BAT.
  # Rename reading 4.SET_TEMPERATURE as desired-temp
  attr mydev ccureadingname 0.(LOWBAT|LOW_BAT):+battery,1.SET_TEMPERATURE:desired-temp
  # Store values of readings n.PRESS_SHORT in new reading pressed.
  # Value of pressed is 1/true if any button is pressed
  attr mydev ccureadingname [1-4].PRESSED_SHORT:+pressed`
- ccuscaleval <datapoint>:<factor>[,...]
  ccuscaleval <[!]datapoint>:<min>:<max>:<minn>:<maxn>[,...]
  Scale, spread, shift and optionally reverse values before executing set datapoint commands or after executing get datapoint commands / before storing values in readings.
  If first syntax is used during get the value read from CCU is devided by factor. During set the value is multiplied by factor.
  With second syntax one must specify the interval in CCU (min,max) and the interval in FHEM (minn, maxn). The scaling factor is calculated automatically. If parameter datapoint starts with a '!' the resulting value is reversed.
  Example: Scale values of datapoint LEVEL for blind actor and reverse values
  `attr myblind ccuscale !LEVEL:0:1:0:100`
- ccuverify {0 | 1 | 2}
  If set to 1 a datapoint is read for verification after set operation. If set to 2 the corresponding reading will be set to the new value directly after setting a datapoint in CCU without any verification.
- controldatapoint <datapoint>
  Set datapoint for device control. Can be use to realize user defined control elements for setting control datapoint. For example if datapoint of thermostat control is SET_TEMPERATURE one can define a slider for setting the destination temperature with following attributes:
  attr mydev controldatapoint SET_TEMPERATURE
  attr mydev webCmd control
  attr mydev widgetOverride control:slider,10,1,25
- disable {0 | 1}
  Disable client device.
- hmstatevals <subst-rule>[;...]
  Define building rules and substitutions for reading hmstate. Syntax of subst-rule is
  [=<reading>;]<datapoint-expr>!<{#n1-m1|regexp}>:<text>[,...]
  The syntax is almost the same as of attribute 'substitute', except there's no channel specification possible for datapoint and parameter datapoint-expr is a regular expression.
  The value of the I/O device attribute 'ccudef-hmstatevals' is appended to the value of this attribute. The default value of 'ccudef-hmstatevals' is '^UNREACH!(1|true):unreachable;LOW_?BAT!(1|true):warn_battery'. Normally one should not specify a substitution rule for the "good" value of an error datapoint (i.e. 0 for UNREACH). If none of the rules is matching, reading 'hmstate' is set to value of reading 'state'.
  Parameter text can contain variables in format ${varname}. The variable $value is substituted by the original datapoint value. All other variables must match with a valid datapoint name or a combination of channel number and datapoint name seperated by a '.'.
  Optionally the name of the HomeMatic state reading can be specified at the beginning of the attribute in format =<reading>;. The default reading name is 'hmstate'.
- statedatapoint <datapoint>
  Set state datapoint used by some commands like 'set devstate'.
- statevals <text>:<text>[,...]
  Define substitution for values of set commands. The parameters text are available as set commands.
  Example:
  `attr my_switch statevals on:true,off:false
  set my_switch on`
- stripnumber {0 | 1 | 2 | -n}
  Remove trailing digits or zeroes from floating point numbers and/or round floating point numbers. If attribute is negative (-0 is valid) floating point values are rounded to the specified number of digits before they are stored in readings. The meaning of values 0-2 is:
  0 = Floating point numbers are stored as read from CCU (i.e. with trailing zeros)
  1 = Trailing zeros are stripped from floating point numbers except one digit.
  2 = All trailing zeros are stripped from floating point numbers.
- substexcl <reading-expr>
  Exclude values of readings matching reading-expr from substitution. This is helpful for reading 'control' if the reading is used for a slider widget and the corresponding datapoint is assigned to attribute statedatapoint and controldatapoint.
- substitute <subst-rule>[;...]
  Define substitutions for datapoint/reading values. Syntax of subst-rule is
  [[<channelno.>]<datapoint>[,...]!]<{#n1-m1|regexp}>:<text>[,...]
  Parameter text can contain variables in format ${varname}. The variable ${value} is substituted by the original datapoint value. All other variables must match with a valid datapoint name or a combination of channel number and datapoint name seperated by a '.'.
  Example: Substitute the value of datapoint TEMPERATURE by the string 'T=val deg' and append current value of datapoint 1.HUMIDITY
  `attr my_weather substitute TEMPERATURE!.+:T=${value} deg H=${1.HUMIDITY}%` If rule expression starts with a hash sign a numeric datapoint value is substituted if it fits in the number range n <= value <= m.
  Example: Interpret LEVEL values of dimmer as "on" and "off"
  `attr my_dim substitute LEVEL!#0-0:off,#1-100:on`

### HMCCUDEV

The module implements Homematic CCU devices as client devices for HMCCU. A HMCCU I/O device must exist before a client device can be defined. If a CCU channel is not found execute command 'get devicelist' in I/O device.
This reference contains only commands and attributes which differ from module HMCCUCHN. Define

`define <name> HMCCUDEV {<device> | 'virtual'} [<statechannel>] [readonly] [defaults] [{group={device|channel}[,...]|groupexp=regexp] [iodev=<iodev-name>]`
If option 'readonly' is specified no set command will be available. With option 'defaults' some default attributes depending on CCU device type will be set. Default attributes are only available for some device types. Parameter statechannel corresponds to attribute 'statechannel'.
A HMCCUDEV device supports CCU group devices. The CCU devices or channels related to a group device are specified by using options 'group' or 'groupexp' followed by the names or addresses of the CCU devices or channels. By using 'groupexp' one can specify a regular expression for CCU device or channel names.
It's also possible to group any kind of CCU devices or channels without defining a real group in CCU by using option 'virtual' instead of a CCU device specification.
Examples:
`# Simple device by using CCU device name
define window_living HMCCUDEV WIN-LIV-1
# Simple device by using CCU device address and with state channel
define temp_control HMCCUDEV BidCos-RF.LEQ1234567 1
# Simple read only device by using CCU device address and with default attributes
define temp_sensor HMCCUDEV BidCos-RF.LEQ2345678 1 readonly defaults # Group device by using CCU group device and 3 group members
define heating_living HMCCUDEV GRP-LIV group=WIN-LIV,HEAT-LIV,THERM-LIV`

Set

- set <name> clear [<reading-exp>]
  see HMCCUCHN
- set <name> config [<channel-number>] <parameter>=<value> [...]
  Set configuration parameter of CCU device or channel. Valid parameters can be listed by using command 'get configdesc'.
- set <name> datapoint [<channel-number>.]<datapoint> <value>
  Set value of a datapoint of a CCU device channel. If channel number is not specified state channel is used. String \_ is substituted by blank.
  Example:
  `set temp_control datapoint 1.SET_TEMPERATURE 21`
- set <name> defaults
  Set default attributes for CCU device type. Default attributes are only available for some device types.
- set <name> devstate <value>
  Set state of a CCU device channel. Channel and state datapoint must be defined as attribute 'statedatapoint'. If value contains string \_ it is substituted by blank.
- set <name> on-for-timer <ontime>
  see HMCCUCHN
- set <name> on-till <timestamp>
  see HMCCUCHN
- set <name> pct <value;> [<ontime> [<ramptime>]]
  see HMCCUCHN
- set <name> <statevalue>
  State datapoint of a CCU device channel is set to 'statevalue'. State channel and state datapoint must be defined as attribute 'statedatapoint'. Values for statevalue are defined by setting attribute 'statevals'.
  Example:
  `attr myswitch statedatapoint 1.STATE
  attr myswitch statevals on:true,off:false
  set myswitch on`
- set <name> toggle
  see HMCCUCHN
- ePaper Display
  This display has 5 text lines. The lines 1,2 and 4,5 are accessible via config parameters TEXTLINE_1 and TEXTLINE_2 in channels 1 and 2. Example:
  `define HM_EPDISP HMCCUDEV CCU_EPDISP
  set HM_EPDISP config 2 TEXTLINE_1=Line1
  set HM_EPDISP config 2 TEXTLINE_2=Line2
  set HM_EPDISP config 1 TEXTLINE_1=Line4
  set HM_EPDISP config 1 TEXTLINE_2=Line5
  `
  The lines 2,3 and 4 of the display can be accessed by setting the datapoint SUBMIT of the display to a string containing command tokens in format 'parameter=value'. The following commands are allowed:
  - text1-3=Text - Content of display line 2-4
  - icon1-3=IconCode - Icons of display line 2-4
  - sound=SoundCode - Sound
  - signal=SignalCode - Optical signal
  - pause=Seconds - Pause between signals (1-160)
  - repeat=Count - Repeat count for sound (0-15)
  IconCode := ico_off, ico_on, ico_open, ico_closed, ico_error, ico_ok, ico_info, ico_newmsg, ico_svcmsg
  SignalCode := sig_off, sig_red, sig_green, sig_orange
  SoundCode := snd_off, snd_longlong, snd_longshort, snd_long2short, snd_short, snd_shortshort, snd_long
  Example:
  `set HM_EPDISP datapoint 3.SUBMIT text1=Line2,text2=Line3,text3=Line4,sound=snd_short, signal=sig_red`

Get

- get <name> config [<channel-number>] [<filter-expr>]
  Get configuration parameters of CCU device. If attribute 'ccureadings' is set to 0 parameters are displayed in browser window (no readings set). Parameters can be filtered by filter-expr.
- get <name> configdesc [<channel-number>] [<rpcport>]
  Get description of configuration parameters for CCU device. Default value for Parameter rpcport is 2001 (BidCos-RF). Other valid values are 2000 (wired) and 2010 (HMIP).
- get <name> configlist [<channel-number>] [<filter-expr>]
  Display configuration parameters of CCU device. Parameters can be filtered by filter-expr.
- get <name> datapoint [<channel-number>.]<datapoint>
  Get value of a CCU device datapoint. If channel-number is not specified state channel is used.
- get <name> defaults
  see HMCCUCHN
- get <name> deviceinfo [{State | Value}]
  Display all channels and datapoints of device with datapoint values and types.
- get <name> devstate
  Get state of CCU device. Attribute 'statechannel' must be set. Default state datapoint STATE can be modified by attribute 'statedatapoint'.
- get <name> update [{State | Value}]
  see HMCCUCHN

Attributes

To reduce the amount of events it's recommended to set attribute 'event-on-change-reading' to '.*'.
- ccuackstate {0 | 1}
  see HMCCUCHN
- ccucalculate <value>:<reading>[:<dp-list>[;...]
  Calculate special values like dewpoint based on datapoints specified in dp-list. Datapoints in dp-list must be specified in format <channelno>.<datapoint>. The result is stored in reading. The following values are supported:
  dewpoint = calculate dewpoint, dp-list = <temperature>,<humidity>
- ccuflags {nochn0, trace}
  see HMCCUCHN
- ccuget {State | Value}
  see HMCCUCHN
- ccureadings {0 | 1}
  see HMCCUCHN
- ccureadingfilter <filter-rule[,...]>
  see HMCCUCHN
- ccureadingformat {address[lc] | name[lc] | datapoint[lc]}
  see HMCCUCHN
- ccureadingname <old-readingname-expr>:<new-readingname>[,...]
  see HMCCUCHN
- ccuscaleval <datapoint>:<factor>[,...]
  ccuscaleval <[!]datapoint>:<min>:<max>:<minn>:<maxn>[,...]
  see HMCCUCHN
- ccuverify {0 | 1 | 2}
  see HMCCUCHN
- controldatapoint <channel-number.datapoint>
  Set channel number and datapoint for device control. see HMCCUCHN
- disable {0 | 1}
  see HMCCUCHN
- hmstatevals <subst-rule>[;...]
  see HMCCUCHN
- statechannel <channel-number>
  Channel for setting device state by devstate command. Deprecated, use attribute 'statedatapoint' instead.
- statedatapoint [<channel-number>.]<datapoint>
  Set state channel and state datapoint for setting device state by devstate command. Default is STATE. If 'statedatapoint' is not defined at least attribute 'statechannel' must be set.
- statevals <text>:<text>[,...]
  see HMCCUCHN
- stripnumber {0 | 1 | 2 | -n}
  see HMCCUCHN
- substexcl <reading-expr>
  see HMCCUCHN
- substitute <subst-rule>[;...]
  see HMCCUCHN

### HMLAN

The HMLAN is the fhem module for the eQ-3 HomeMatic LAN Configurator.
A description on how to use hmCfgUsb can be found follwing the link.
The fhem module will emulate a CUL device, so the CUL_HM module can be used to define HomeMatic devices.
In order to use it with fhem you must disable the encryption first with the "HomeMatic Lan Interface Configurator"
(which is part of the supplied Windows software), by selecting the device, "Change IP Settings", and deselect "AES Encrypt Lan Communication".
This device can be used in parallel with a CCU and (readonly) with fhem. To do this:

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

Define

`define <name> HMLAN <ip-address>[:port]`
port is 1000 by default.
If the ip-address is called none, then no device will be opened, so you can experiment without hardware attached.

Set

- hmPairForSec
- hmPairSerial
- reopen reconnect the device
- restart Restart the device
- reassignIDs Syncs the IDs between HMLAN and the FHEM list. Usually this is done automatically and only is recomended if there is a difference in counts.

Get

- assignIDs Gibt eine Liste aller diesem IO zugewiesenen IOs aus.

Attributes

- addvaltrigger
- do_not_notify
- dummy
- logIDs
  enables selective logging of HMLAN messages. A list of HMIds or names can be entered, comma separated, which shall be logged.
  The attribute only allows device-IDs, not channel IDs. Channel-IDs will be modified to device-IDs automatically. all will log raw messages for all HMIds
  sys will log system related messages like keep-alive
  in order to enable all messages set "all,sys"
- loadLevel
  loadlevel will be mapped to reading vaues.
  0:low,30:mid,40:batchLevel,90:high,99:suspended
  the batchLevel value will be set to 40 if not entered. This is the level at which background message generation e.g. for autoReadReg will be stopped
- hmId
- hmKey
- hmKey2
- hmKey3
- hmKey4
- hmKey5
  AES keys for the HMLAN adapter.
  The key is converted to a hash. If a hash is given directly it is not converted but taken directly. Therefore the original key cannot be converted back
- hmProtocolEvents
- respTime
  Define max response time of the HMLAN adapter in seconds. Default is 1 sec.
  Longer times may be used as workaround in slow/instable systems or LAN configurations.
- wdTimer
  Time in sec to trigger HMLAN. Values between 5 and 25 are allowed, 25 is default.
  It is not recommended to change this timer. If problems are detected with
  HLMLAN disconnection it is advisable to resolve the root-cause of the problem and not symptoms.
- hmLanQlen
  defines queuelength of HMLAN interface. This is therefore the number of simultanously send messages. increasing values may cause higher transmission speed. It may also cause retransmissions up to data loss.
  Effects can be observed by watching protocol events
  1 - is a conservatibe value, and is default
  5 - is critical length, likely cause message loss

parameter

- assignedIDsCnt
  number of IDs that are assigned to HMLAN by FHEM. If the number reported by HMLAN differ it will be reported as 'reported'.
  It is recommended to resync HMLAN using the command 'assignIDs'.
- msgKeepAlive
  performance of keep-alive messages.
  dlyMax: maximum delay of sheduled message-time to actual message send.
  bufferMin: minimal buffer left to before HMLAN would likely disconnect due to missing keepAlive message. bufferMin will be reset to 30sec if attribut wdTimer is changed.
  if dlyMax is high (several seconds) or bufferMin goes to "0" (normal is 4) the system suffers on internal delays. Reasons for the delay might be explored. As a quick solution wdTimer could be decreased to trigger HMLAN faster.
- msgLoadCurrent
  Current transmit load of HMLAN. When capacity reaches 100% HMLAN stops sending and waits for reduction. See also: loadLevel
- msgLoadHistoryAbs
  Historical transmition load of IO.
- msgParseDly
  calculates the delay of messages in ms from send in HMLAN until processing in FHEM. It therefore gives an indication about FHEM system performance.

parameter and readings

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

### HMS

Define

`define <name> HMS <housecode>`
`<housecode>` is a four digit hex number, corresponding to the address of the HMS device.
Examples:

`define temp HMS 1234`

Notes:

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

Set

N/A

Get

N/A

Attributes

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

### HMUARTLGW

HMUARTLGW provides support for the eQ-3 HomeMatic Wireless LAN Gateway (HM-LGW-O-TW-W-EU) and the eQ-3 HomeMatic UART module (HM-MOD-UART), which is part of the HomeMatic wireless module for the Raspberry Pi (HM-MOD-RPI-PCB).
Define

`define <name> HMUARTLGW <device>`
The <device>-parameter depends on the device-type:

- HM-MOD-UART: <device> specifies the serial port to communicate with. The baud-rate is fixed at 115200 and does not need to be specified.
  If the HM-MOD-UART is connected to the network by a serial bridge, the connection has to be defined in an URL-like format (`uart://ip:port`).
- HM-LGW-O-TW-W-EU: <device> specifies the IP address or hostname of the gateway, optionally followed by : and the port number of the BidCoS-port (default when not specified: 2000).

Examples:

- Local HM-MOD-UART at `/dev/ttyAMA0`:
  `define myHmUART HMUARTLGW /dev/ttyAMA0`
- LAN Gateway at `192.168.42.23`:
  `define myHmLGW HMUARTLGW 192.168.42.23`
- Remote HM-MOD-UART using `socat` on a Raspberry Pi:
  `define myRemoteHmUART HMUARTLGW uart://192.168.42.23:12345`
  Remote Raspberry Pi:
  `$ socat TCP4-LISTEN:12345,fork,reuseaddr /dev/ttyAMA0,raw,echo=0,b115200`

Set

- close
  Closes the connection to the device.
- hmPairForSec
- hmPairSerial
- open
  Opens the connection to the device and initializes it.
- reopen
  Reopens the connection to the device and reinitializes it.
- restart
  Reboots the device.
- updateCoPro </path/to/firmware.eq3>
  Update the coprocessor-firmware (reading D-firmware) from the supplied file. Source for firmware-images (version 1.4.1, official eQ-3 repository):
  - HM-MOD-UART: coprocessor_update.eq3
  - HM-LGW-O-TW-W-EU: coprocessor_update_hm_only.eq3
    Please also make sure that D-LANfirmware is at least at version 1.1.5. To update to this version, use the eQ-3 CLI tools (see wiki) or use the eQ-3 netfinder with this firmware image: hm-lgw-o-tw-w-eu_update.eq3
    Do not flash hm-lgw-o-tw-w-eu_update.eq3 with updateCoPro!

Get

- assignIDs
  Returns the HomeMatic devices currently assigned to this IO-device.

Attributes

- csmaCa
  Enable or disable CSMA/CA (Carrier sense multiple access with collision avoidance), also known as listen-before-talk.
  Default: 0 (disabled)
- dummy
  Do not interact with the device at all, only define it.
  Default: not set
- dutyCycle
  Enable or disable the duty-cycle check (1% rule) performed by the wireless module.
  Disabling this might be illegal in your country, please check with local regulations!
  Default: 1 (enabled)
- hmId
- hmKey
- hmKey2
- hmKey3
- lgwPw
  AES password for the eQ-3 HomeMatic Wireless LAN Gateway. The default password is printed on the back of the device (but can be changed by the user). If AES communication is enabled on the LAN Gateway (default), this attribute has to be set to the correct value or communication will not be possible. In addition, the perl-module Crypt::Rijndael (which provides the AES cipher) must be installed.
- logIDs
  Enables selective logging of HMUARTLGW messages. A list of comma separated HMIds or HM device names/channel names can be entered which shall be logged.
  - all: will log raw messages for all HMIds
  - sys: will log system related messages like keep-alive
  In order to enable all messages set: all,sys
- qLen
  Maximum number of commands in the internal queue of the HMUARTLGW module. New commands when the queue is full are dropped.
  Default: 20

### HMinfo

HMinfo is a module to support getting an overview of eQ-3 HomeMatic devices as defines in CUL_HM.
Status information and counter
HMinfo gives an overview on the CUL_HM installed base including current conditions. Readings and counter will not be updated automatically due to performance issues.
Command update must be used to refresh the values.

`
set hm update
`

Webview of HMinfo providee details, basically counter about how many CUL_HM entities experience exceptional conditions. It contains

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

It also allows some HM wide commands such as store all collected register settings.
Commands are executed on all HM entities. If applicable and evident execution is restricted to related entities. e.g. rssi is executed on devices only since channels do not support rssi values.
Filter

can be applied as following:
`set <name> <cmd> <filter> [<param>]`
whereby filter has two segments, typefilter and name filter
[-dcasev] [-f <filter>]
filter for types

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

and/or filter for names:

- -f <filter> :regexp to filter entity names

Example:

`set hm param -d -f dim state # display param 'state' for all devices whos name contains dim
set hm param -c -f ^dimUG$ peerList # display param 'peerList' for all channels whos name is dimUG
set hm param -dcv expert # get attribut expert for all channels,devices or virtuals
`

Define

`define <name> HMinfo`
Just one entity needs to be defined without any parameter.

Get

- models
  list all HM models that are supported in FHEM
- param [filter] <name> <name>...
  returns a table of parameter values (attribute, readings,...) for all entities as a table
- register [filter]
  provides a tableview of register of an entity
- regCheck [filter]
  performs a consistency check on register readings for completeness
- peerCheck [filter]
  performs a consistency check on peers. If a peer is set in a channel it will check wether the peer also exist on the opposit side.
- peerXref [filter]
  provides a cross-reference on peerings, a kind of who-with-who summary over HM
- configCheck [filter]
  performs a consistency check of HM settings. It includes regCheck and peerCheck
- templateList [<name>]
  list defined templates. If no name is given all templates will be listed
- templateUsg <template> [sortPeer|sortTemplate]
  templare usage
  template filters the output
- msgStat [filter]
  statistic about message transferes over a week
- protoEvents [filter]
  important view about pending commands and failed executions for all devices in a single table.
  Consider to clear this statistic use clear msgEvents.
- rssi [filter]
  statistic over rssi data for HM entities.
- templateChk [filter] <template> <peer:[long|short]> [<param1> ...]
  verifies if the register-readings comply to the template
  Parameter are identical to templateSet
  The procedure will check if the register values match the ones provided by the template
  If no peer is necessary use none to skip this entry
  Example to verify settings
  `set hm templateChk -f RolloNord BlStopUpLg none 1 2 # RolloNord, no peer, parameter 1 and 2 given
  set hm templateChk -f RolloNord BlStopUpLg peerName:long # RolloNord peerName, long only
  set hm templateChk -f RolloNord BlStopUpLg peerName # RolloNord peerName, long and short
  set hm templateChk -f RolloNord BlStopUpLg peerName:all # RolloNord peerName, long and short
  set hm templateChk -f RolloNord BlStopUpLg all:long # RolloNord any peer, long only
  set hm templateChk -f RolloNord BlStopUpLg all # RolloNord any peer,long and short
  set hm templateChk -f Rollo.* BlStopUpLg all # each Rollo* any peer,long and short
  set hm templateChk BlStopUpLg # each entities
  set hm templateChk # all assigned templates
  set hm templateChk sortTemplate # all assigned templates sortiert nach Template
  set hm templateChk sortPeer # all assigned templates sortiert nach Peer
  `

Set

Even though the commands are a get funktion they are implemented as set to allow simple web interface usage
- update
  updates HM status counter.
- autoReadReg [filter]
  schedules a read of the configuration for the CUL_HM devices with attribut autoReadReg set to 1 or higher.
- clear [filter] [msgEvents|readings|msgStat|register|rssi]
  executes a set clear ... on all HM entities
  - protocol relates to set clear msgEvents
  - readings relates to set clear readings
  - rssi clears all rssi counters
  - msgStat clear HM general message statistics
  - register clears all register-entries in readings
- saveConfig [filter] [<file>]
  performs a save for all HM register setting and peers. See CUL_HM saveConfig.
  purgeConfig will be executed automatically if the stored filesize exceeds 1MByte.
- archConfig [filter] [<file>]
  performs saveConfig for entities that appeare to have achanged configuration. It is more conservative that saveConfig since incomplete sets are not stored.
  Option -a force an archieve for all devices that have a complete set of data
- loadConfig [filter] [<file>]
  loads register and peers from a file saved by saveConfig.
  It should be used carefully since it will add data to FHEM which cannot be verified. No readings will be replaced, only missing readings will be added. The command is mainly meant to be fill in readings and register that are hard to get. Those from devices which only react to config may not easily be read.
  Therefore it is strictly up to the user to fill valid data. User should consider using autoReadReg for devices that can be read.
  The command will update FHEM readings and attributes. It will not reprogramm any device.
- purgeConfig [filter] [<file>]
  purge (reduce) the saved config file. Due to the cumulative storage of the register setting purge will use the latest stored readings and remove older one. See CUL_HM saveConfig.
- verifyConfig [filter] [<file>]
  Compare date in config file to the currentactive data and report differences. Possibly usable with a known-good configuration that was saved before. It may make sense to purge the config file before. See CUL_HM purgeConfig.
- tempList [filter] [save|restore|verify|status|genPlot] [<file>]
  this function supports handling of tempList for thermstates. It allows templists to be saved in a separate file, verify settings against the file and write the templist of the file to the devices.
  - save saves tempList readings of the system to the file.
    Note that templist as available in FHEM is put to the file. It is up to the user to make sure the data is actual
    Storage is not cumulative - former content of the file will be removed
  - restore available templist as defined in the file are written directly to the device
  - verify file data is compared to readings as present in FHEM. It does not verify data in the device - user needs to ensure actuallity of present readings
  - status gives an overview of templates being used by any CUL_HM thermostat. It alls showes templates being defined in the relevant files.
  - genPlot generates a set of records to display templates graphicaly.
    Out of the given template-file it generates a .log extended file which contains log-formated template data. timestamps are set to begin Year 2000.
    A prepared .gplot file will be added to gplot directory.
    Logfile-entity <file>_Log will be added if not already present. It is necessary for plotting.
    SVG-entity <file>_SVG will be generated if not already present. It will display the graph.
  - file name of the file to be used. Default: tempList.cfg
  - filename is the name of the file to be used. Default ist tempList.cfg
  File example
  `entities:HK1_Climate,HK2_Clima
  tempListFri>07:00 14.0 13:00 16.0 16:00 18.0 21:00 19.0 24:00 14.0
  tempListMon>07:00 14.0 16:00 18.0 21:00 19.0 24:00 14.0
  tempListSat>08:00 14.0 15:00 18.0 21:30 19.0 24:00 14.0
  tempListSun>08:00 14.0 15:00 18.0 21:30 19.0 24:00 14.0
  tempListThu>07:00 14.0 16:00 18.0 21:00 19.0 24:00 14.0
  tempListTue>07:00 14.0 13:00 16.0 16:00 18.0 21:00 19.0 24:00 15.0
  tempListWed>07:00 14.0 16:00 18.0 21:00 19.0 24:00 14.0
  entities:hk3_Climate
  tempListFri>06:00 17.0 12:00 21.0 23:00 20.0 24:00 19.5
  tempListMon>06:00 17.0 12:00 21.0 23:00 20.0 24:00 17.0
  tempListSat>06:00 17.0 12:00 21.0 23:00 20.0 24:00 17.0
  tempListSun>06:00 17.0 12:00 21.0 23:00 20.0 24:00 17.0
  tempListThu>06:00 17.0 12:00 21.0 23:00 20.0 24:00 17.0
  tempListTue>06:00 17.0 12:00 21.0 23:00 20.0 24:00 17.0
  tempListWed>06:00 17.0 12:00 21.0 23:00 20.0 24:00 17.0
  `
  File keywords
  - entities comma separated list of entities which refers to the temp lists following. The actual entity holding the templist must be given - which is channel 04 for RTs or channel 02 for TCs
  - tempList... time and temp couples as used in the set tempList commands
- cpRegs <src:peer> <dst:peer>
  allows to copy register, setting and behavior of a channel to another or for peers from the same or different channels. Copy therefore is allowed intra/inter device and intra/inter channel.
  src:peer is the source entity. Peer needs to be given if a peer behabior beeds to be copied
  dst:peer is the destination entity.
  Example
  `set hm cpRegs blindR blindL # will copy all general register (list 1)for this channel from the blindR to the blindL entity. This includes items like drive times. It does not include peers related register (list 3/4)
  set hm cpRegs blindR:Btn1 blindL:Btn2 # copy behavior of Btn1/blindR relation to Btn2/blindL
  set hm cpRegs blindR:Btn1 blindR:Btn2 # copy behavior of Btn1/blindR relation to Btn2/blindR, i.e. inside the same Actor
  `
  Restrictions:
  cpRegs will not add any peers or read from the devices. It is up to the user to read register in advance
  cpRegs is only allowed between identical models
  cpRegs expets that all readings are up-to-date. It is up to the user to ensure data consistency.
- templateDef <name> <param> <desc> <reg1:val1> [<reg2:val2>] ...
  define a template.
  param gives the names of parameter necesary to execute the template. It is template dependant and may be onTime or brightnesslevel. A list of parameter needs to be separated with colon
  param1:param2:param3
  if del is given as parameter the template is removed
  desc shall give a description of the template
  reg:val is the registername to be written and the value it needs to be set to.
  In case the register is from link set and can destinguist between long and short it is necessary to leave the leading sh or lg off.
  if parameter are used it is necessary to enter p. as value with p0 first, p1 second parameter
  Example
  `set hm templateDef SwOnCond level:cond "my description" CtValLo:p0 CtDlyOn:p1 CtOn:geLo
  set hm templateDef SwOnCond del # delete a template
  set hm templateDef SwOnCond fromMaster <masterChannel> <peer:[long|short]># define a template with register as of the example
  set hm templateDef SwOnCond fromMaster myChannel peerChannel:long #
  `
- templateSet <entity> <template> <peer:[long|short]> [<param1> ...]
  sets a bunch of register accroding to a given template. Parameter may be added depending on the template setup.
  templateSet will collect and accumulate all changes. Finally the results are written streamlined.
  entity: peer is the source entity. Peer needs to be given if a peer behabior beeds to be copied
  template: one of the programmed template
  peer: [long|short]:if necessary a peer needs to be given. If no peer is used enter '0'. with a peer it should be given whether it is for long or short keypress
  param: number and meaning of parameter depends on the given template
  Example could be (templates not provided, just theoretical)
  `set hm templateSet Licht1 staircase FB1:short 20
  set hm templateSet Licht1 staircase FB1:long 100
  `
  Restrictions:
  User must ensure to read configuration prior to execution.
  templateSet may not setup a complete register block but only a part if it. This is up to template design.
- templateDel <entity> <template> <peer:[long|short]> ]
  remove a template installed by templateSet
- templateExe <template>
  executes the register write once again if necessary (e.g. a device had a reset)

Attributes

- sumStatus
  Warnings: list of readings that shall be screend and counted based on current presence. I.e. counter is the number of entities with this reading and the same value. Readings to be searched are separated by comma.
  Example:
  `attr hm sumStatus battery,sabotageError
  `
  will cause a reading like
  W_sum_batterie ok:5 low:3
  W_sum_sabotageError on:1
  Note: counter with '0' value will not be reported. HMinfo will find all present values autonomously
  Setting is meant to give user a fast overview of parameter that are expected to be system critical
- sumERROR Similar to sumStatus but with a focus on error conditions in the system. Here user can add readingvalues that are not displayed. I.e. the value is the good-condition that will not be counted.
  This way user must not know all error values but it is sufficient to supress known non-ciritical ones.
  Example:
  `attr hm sumERROR battery:ok,sabotageError:off,overheat:off,Activity:alive:unknown
  `
  will cause a reading like
  `ERR_batterie low:3
  ERR_sabotageError on:1
  ERR_overheat on:3
  ERR_Activity dead:5
  `
- autoUpdate retriggers the command update periodically.
  Example:
  `attr hm autoUpdate 00:10
  `
  will trigger the update every 10 min
- autoArchive if set fhem will update the configFile each time the new data is available. The update will happen with autoUpdate. It will not work it autoUpdate is not used.
  see also archConfig
- hmAutoReadScan defines the time in seconds CUL_HM tries to schedule the next autoRead from the queue. Despite this timer FHEM will take care that only one device from the queue will be handled at one point in time. With this timer user can stretch timing even further - to up to 300sec min delay between execution.
  Setting to 1 still obeys the "only one at a time" prinzip.
  Note that compressing will increase message load while stretch will extent waiting time.
- hmIoMaxDly max time in seconds CUL_HM stacks messages if the IO device is not ready to send. If the IO device will not reappear in time all command will be deleted and IOErr will be reported.
  Note: commands will be executed after the IO device reappears - which could lead to unexpected activity long after command issue.
  default is 60sec. max value is 3600sec
- configDir default directory where to store and load configuration files from. This path is used as long as the path is not given in a filename of a given command.
  It is used by commands like tempList or saveConfig
- configFilename default filename used by saveConfig, purgeConfig, loadConfig
  verifyConfig
- configTempFile<,configTempFile2><,configTempFile2> Liste of Templfiles (weekplan) which are considered in HMInfo and CUL_HM
  Files are comma separated. The first file is default. Its name may be skipped when setting a tempalte.
- hmManualOper set to 1 will prevent any automatic operation, update or default settings in CUL_HM.
- hmDefaults set default params for HM devices. Multiple attributes are possible, comma separated.
  example:
  attr hm hmDefaults hmProtocolEvents:0_off,rssiLog:0
- autoLoadArchive if set the register config will be loaded after reboot automatically. See loadConfig for details

Variables

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

`ERR___rssiCrit LightKittchen,WindowDoor,Remote12
ERR__protocol NACK:2 ResendFail:5 CmdDel:2 CmdPend:1
ERR__protoNames LightKittchen,WindowDoor,Remote12,Ligth1,Light5
ERR_battery: low:2;
ERR_names: remote1,buttonClara,
I_rssiMinLevel 99>:3 80<:0 60<:7 59<:4
W_sum_battery: ok:5;low:2;
W_sum_overheat: off:7;
C_sumDefined: entities:23 device:11 channel:16 virtual:5;
`

### HMtemplate

Edit templates for HM entities. Programming register of HM devices can be bundled to templates and then being assigned to the devices. The editor might be instantiated ony once. Templates will be organized, handled and loaded in HMinfo.
The editor allowes to define, edit, copy and assign and delete templates.
Required: HMinfo needs to be instantiated. Set

following commands are available:

- defTmpl <name>
  Define a new template. Procedure is given in internals once the command is issued.
- tpl_typechoose whether the template will be:
  - basic not peer related register only
  - peer-both only peer related register, setting short and long press reaction in one template
  - peer-Short only peer related register, will define one short or long press behavior
  - peer-Long only peer related register, will define one short or long press behavior
- tpl_sourceselect the entity which will be used as master for the template
- tpl_peerselect the peer of the entity which will be used as master for the template. This is onle necessary for types that require peers.
- tpl_paramsif the template shall have parameter those need to be defined next.
  parameter will allow to use one template with selected registers to be defined upon appling to the entity.
- tpl_descriptionenter a free text to describe what the entity is about
- tpl_Rega list of attributes will be available after all attribtes above are set. Not edit them. Delete registers which are not used for the template, edit the values as desired.
- savesave the template. After that the template is defined. saveas will allow to define the template with a different name.
- delete <name>
  Delete an existing template
- edit <name>
  Edit an existing template. Change register, parameter and description by change the attributes. See also defTmpl
  saveAs can be used to create a copy of the template.
- select <name>
  Apply an existing template to a entity
  Once the command is issued it is necessary to select the entity, peer and short/long which the entity shall be applied to.
  If the template has parameter the value needs to be set.
  Finally apply the template to teh entity.
- dismiss
  reset HMtemplate and come back to init status
- save, saveAs
  save a template once it is defined

=begin html_DE

### HMtemplate

=end html_DE =cut

### HOMBOT

HOMBOT - LG Homebot robotic vacuum cleaner
After successfully hacking (WiFi-Mod) your Hombot, this Modul enables you to integrate your Hombot to FHEM. The Connection-Interface between FHEM and Hombot is served by Luigi HTTP Server. With this Module, the following is possible:

- Readings about the Status will be saved.
- Choice of cleaning mode
- Start cleaning
- Stop cleaning
- Return to Homebase
- Assign Nickname
- Schedule Weekprogram
- Activate 'Repeat' and 'Turbo'

You need to set up the device for the Hombot like this.
Define

`define <name> HOMBOT <IP-ADRESS>`
Example:

`define Roberta HOMBOT 192.168.0.23`

This command creates a HOMBOT-Device in room HOMBOT. The parameter <IP-ADRESS> determines the IP-Address of your Hombot.
The standard query interval is 180 seconds. You can change it with attribute interval. The interval is dynamic in dependency of the workstatus. For example, the status WORKING is 30 seconds.

The first Readings should already appear after setting up the Device entity.
Readings

- at_* - Reading for the week schedule. Start time for respective day.
- batteryPercent - Battery status in percent %
- cleanMode - Current cleanmode
- cpu_* - Information about CPU load
- currentBumping - Count of collisions with obstacles
- firmware - current installed firmware version
- hombotState - Status of Hombot
- lastClean - Date and Time of last cleaning
- lastSetCommandError - last error message from set command
- lastSetCommandState - last status from set command. Command (un)successfully send
- lastStatusRequestError - last error message from statusRequest command
- lastStatusRequestState - last status from statusRequest command. Command (un)successfully send
- luigiSrvVersion - Version of Luigi HTTP Servers of Hombot
- nickname - Name of Hombot
- num* - Previous started and ended cleanings in corresponding modes
- repeat - Cleaning will repeated Yes/No
- state - Module status
- turbo - Turbo active Yes/No

Set

- cleanMode - set cleaning mode (ZZ-ZigZag / SB-Cell by Cell / SPOT-Spiralcleaning
- cleanStart - Start cleaning
- homing - Stop cleaning and move Hombot back to Base
- nickname - Sets HomBot's Nickname. Not visible in Reading until restart of Luigi-Server or HomBot itself.
- pause - Will pause the cleaning process
- repeat - Repeat cleaning? (true/false)
- schedule - Set of Week schedule. For example, set Roberta schedule Mo=13:30 Di= Mi=14:00,ZZ Do=15:20 Fr= Sa=11:20 So= therefore you can also add modes!
- statusRequest - Requests new Statusreport from Device
- turbo - Activation of Turbomode (true/false)

### HP1000

Define

`define <WeatherStation> HP1000 [<ID> <PASSWORD>]`
Provides webhook receiver for Wifi-based weather station HP1000 and WH2600 of Fine Offset Electronics (e.g. also known as Ambient Weather WS-1001-WIFI).
There needs to be a dedicated FHEMWEB instance with attribute webname set to "weatherstation".
No other name will work as it's hardcoded in the HP1000/WH2600 device itself!
If necessary, this module will create a matching FHEMWEB instance named WEBweatherstation during initial definition.
As the URI has a fixed coding as well there can only be one single HP1000/WH2600 station per FHEM installation.
Example:
`# unprotected instance where ID and PASSWORD will be ignored
define WeatherStation HP1000
# protected instance: Weather Station needs to be configured
# to send this ID and PASSWORD for data to be accepted
define WeatherStation HP1000 MyHouse SecretPassword`
IMPORTANT: In your HP1000/WH2600 hardware device, make sure you use a DNS name as most revisions cannot handle IP addresses correctly.

Attributes

- readingFnAttributes
- wu_id
Weather Underground (Wunderground) station ID
- wu_password
Weather Underground (Wunderground) password
- wu_push
Enable or disable to push data forward to Weather Underground (defaults to 0=no)
- wu_realtime
Send the data to the WU realtime server instead of using the standard server (defaults to 1=yes)

### HTTPMOD

This module provides a generic way to retrieve information from devices with an HTTP Interface and store them in Readings or send information to such devices. It queries a given URL with Headers and data defined by attributes.
From the HTTP Response it extracts Readings named in attributes using Regexes, JSON or XPath also defined by attributes.
To send information to a device, set commands can be configured using attributes.
Prerequisites

- This Module uses the non blocking HTTP function HttpUtils_NonblockingGet provided by FHEM's HttpUtils in a new Version published in December 2013.
  If not already installed in your environment, please update FHEM or install it manually using appropriate commands from your environment.
  Please also note that Fhem HttpUtils need the global attribute dnsServer to be set in order to work really non blocking even when dns requests can not be answered.

Define

`define <name> HTTPMOD <URL> <Interval>`
The module connects to the given URL every Interval seconds, sends optional headers and data and then parses the response.
URL can be "none" and Interval can be 0 if you prefer to only query data manually with a get command and not automatically in a defined interval.
Example:

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

Simple configuration of HTTP Devices

In a simple configuration you don't need to define get or set commands. One common HTTP request is automatically sent in the interval specified in the define command and to the URL specified in the define command.
Optional HTTP headers can be specified as `attr requestHeader1` to `attr requestHeaderX`,
optional POST data as `attr requestData` and then pairs of `attr readingXName` and `attr readingXRegex`, `attr readingXXPath`, `attr readingXXPath-Strict` or `attr readingXJSON` to define how values are parsed from the HTTP response and in which readings they are stored.
(The old syntax `attr readingsNameX` and `attr readingsRegexX` is still supported but it can go away in a future version of HTTPMOD so the new one with `attr readingXName` and `attr readingXRegex` should be preferred.
Example for a PoolManager 5:

`define PM HTTPMOD http://MyPoolManager/cgi-bin/webgui.fcgi 60
attr PM reading01Name PH
attr PM reading01Regex 34.4001.value":[ \t]+"([\d\.]+)"
attr PM reading02Name CL
attr PM reading02Regex 34.4008.value":[ \t]+"([\d\.]+)"
attr PM reading03Name3TEMP
attr PM reading03Regex 34.4033.value":[ \t]+"([\d\.]+)"
attr PM requestData {"get" :["34.4001.value" ,"34.4008.value" ,"34.4033.value", "14.16601.value", "14.16602.value"]}
attr PM requestHeader1 Content-Type: application/json
attr PM requestHeader2 Accept: */*
attr PM stateFormat {sprintf("%.1f Grad, PH %.1f, %.1f mg/l Chlor", ReadingsVal($name,"TEMP",0), ReadingsVal($name,"PH",0), ReadingsVal($name,"CL",0))}
`

The regular expressions used will take the value that matches a capture group. This is the part of the regular expression inside (). In the above example "([\d\.]+)" refers to numerical digits or points between double quotation marks. Only the string consiting of digits and points will match inside (). This piece is assigned to the reading. You can also use regular expressions that have several capture groups which might be helpful when parsing tables. In this case an attribute like `

reading02Regex something[ \t]+([\d\.]+)[ \t]+([\d\.]+)

`

could match two numbers. When you specify only one reading02Name like `

reading02Name Temp

`

the name Temp will be used with the extension -1 and -2 thus giving a reading Temp-1 for the first number and Temp-2 for the second. You can also specify individual names for several readings that get parsed from one regular expression with several capture groups by defining attributes `

reading02-1Name
reading02-2Name ...

` The same notation can be used for formatting attributes like readingXOMap, readingXFormat and so on.
The usual way to define readings is however to have an individual regular expression with just one capture group per reading as shown in the above example.
formating and manipulating values / readings

Values that are parsed from an HTTP response can be further treated or formatted with the following attributes:

`(reading|get)[0-9]*(-[0-9]+)?OExpr
(reading|get)[0-9]*(-[0-9]+)?OMap
(reading|get)[0-9]*(-[0-9]+)?Format
(reading|get)[0-9]*(-[0-9]+)?Decode
(reading|get)[0-9]*(-[0-9]+)?Encode`

They can all be specified for an individual reading, for all readings in one match (e.g. if a regular expression has several capture groups) or for all readings in a get command (defined by getXX) or for all readings in the main reading list (defined by readingXX):

`reading01Format %.1f`

will format the reading with the name specified by the attribute reading01Name to be numerical with one digit after the decimal point.
If the attribute reading01Regex is used and contains several capture groups then the format will be applied to all readings thet are parsed by this regex unless these readings have their own format specified by reading01-1Format, reading01-2Format and so on.

`reading01-2Format %.1f`

Can be used in cases where a regular expression specified as reading1regex contains several capture groups or an xpath specified as reading01XPath creates several readings. In this case reading01-2Format specifies the format to be applied to the second match.

`readingFormat %.1f`

applies to all readings defined by a reading-Attribute that have no more specific format.
If you need to do some calculation on a raw value before it is used as a reading, you can define the attribute `readingOExpr`.
It defines a Perl expression that is used in an eval to compute the readings value. The raw value will be in the variable $val.
Example:

`attr PM reading03OExpr $val * 10
`

Just like in the above example of the readingFormat attributes, readingOExpr and the other following attributes can be applied on several levels.
To map a raw numerical value to a name, you can use the readingOMap attribute. It defines a mapping from raw values read from the device to visible values like "0:mittig, 1:oberhalb, 2:unterhalb".
Example:

`attr PM reading02-3OMap 0:kalt, 1:warm, 2:sehr warm`

If the value read from a http response is 1, the above map will transalte it to the string warm and the reading value will be set to warm.
To convert character sets, the module can first decode a string read from the device and then encode it again. For example:

`attr PM getDecode UTF-8`

This applies to all readings defined for Get-Commands.

Configuration to define a `set` command and send data to a device

When a set option is defined by attributes, the module will use the value given to the set command and translate it into an HTTP-Request that sends the value to the device.
HTTPMOD has a built in replacement that replaces $val in URLs, headers or Post data with the value passed in the set command.
This value is internally stored in the internal "value" ($hash->{value}) so it can also be used in a user defined replacement.
Extension to the above example for a PoolManager 5:

`attr PM set01Name HeizungSoll
attr PM set01URL http://MyPoolManager/cgi-bin/webgui.fcgi?sid=$sid
attr PM set01Hint 6,10,20,30
attr PM set01Min 6
attr PM set01Max 30
attr PM setHeader1 Content-Type: application/json
attr PM set01Data {"set" :{"34.3118.value" :"$val" }}
`

This example defines a set option with the name HeizungSoll.
By issuing `set PM HeizungSoll 10` in FHEM, the value 10 will be sent in the defined HTTP Post to URL `http://MyPoolManager/cgi-bin/webgui.fcgi` and with Post Data as
`{"set" :{"34.3118.value" :"10" }}`
The optional attributes set01Min and set01Max define input validations that will be checked in the set function.
the optional attribute set01Hint will define the way the Fhemweb GUI shows the input. This might be a slider or a selection list for example.
The HTTP response to such a request will be ignored unless you specify the attribute `setParseResponse` for all set commands or `set01ParseResponse` for the set command with number 01.
If the HTTP response to a set command is parsed then this is done like the parsing of responses to get commands and you can use the attributes ending e.g. on Format, Encode, Decode, OMap and OExpr to manipulate / format the values read.
If a parameter to a set command is not numeric but should be passed on to the device as text, then you can specify the attribute setTextArg. For example:

`attr PM set01TextArg`

If a set command should not require a parameter at all, then you can specify the attribute NoArg. For example:

`attr PM set03Name On attr PM set03NoArg`

Configuration to define a `get` command

When a get option is defined by attributes, the module allows querying additional values from the device that require individual HTTP-Requests or special parameters to be sent
Extension to the above example:

`attr PM get01Name MyGetValue
attr PM get01URL http://MyPoolManager/cgi-bin/directory/webgui.fcgi?special=1?sid=$sid
attr PM getHeader1 Content-Type: application/json
attr PM get01Data {"get" :{"30.1234.value"}}
`

This example defines a get option with the name MyGetValue.
By issuing `get PM MyGetValue` in FHEM, the defined HTTP request is sent to the device.
The HTTP response is then parsed using the same readingXXName and readingXXRegex attributes as above so additional pairs will probably be needed there for additional values.
If the new get parameter should also be queried regularly, you can define the following optional attributes:

`attr PM get01Poll 1
attr PM get01PollDelay 300
`

The first attribute includes this reading in the automatic update cycle and the second defines an alternative lower update frequency. When the interval defined initially in the define is over and the normal readings are read from the device, the update function will check for additional get parameters that should be included in the update cycle. If a PollDelay is specified for a get parameter, the update function also checks if the time passed since it has last read this value is more than the given PollDelay. If not, this reading is skipped and it will be rechecked in the next cycle when interval is over again. So the effective PollDelay will always be a multiple of the interval specified in the initial define.
Please note that each defined get command that is included in the regular update cycle will create its own HTTP request. So if you want to extract several values from the same request, it is much more efficient to do this by defining readingXXName and readingXXRegex, XPath or JSON attributes and to specify an interval and a URL in the define of the HTTPMOD device.

Handling sessions and logging in

In simple cases logging in works with basic authentication. In the case HTTPMOD accepts a username and password as part of the URL in the form http://User:Password@192.168.1.18/something
However basic auth is seldom used. If you need to fill in a username and password in a HTML form and the session is then managed by a session id, here is how to configure this: when sending data to an HTTP-Device in a set, HTTPMOD will replace any `$sid` in the URL, Headers and Post data with the internal `$hash->{sid}`. To authenticate towards the device and give this internal a value, you can use an optional multi step login procedure defined by the following attributes:

- sid[0-9]*URL
- sid[0-9]*Data.*
- sid[0-9]*Header.*
- idRegex
- idJSON
- idXPath
- idXPath-Strict
- (get|set|sid)[0-9]*IdRegex
- (get|set|sid)[0-9]*IdJSON
- (get|set|sid)[0-9]*IdXPath
- (get|set|sid)[0-9]*IdXPath-Strict

Each step can have a URL, Headers and Post Data. To extract the actual session Id, you can use regular expressions, JSON or XPath just like for the parsing of readings but with the attributes (get|set|sid)[0-9]*IdRegex, (get|set|sid)[0-9]*IdJSON, (get|set|sid)[0-9]*IdXPath or (get|set|sid)[0-9]*IdXPath-Strict.
An extracted session Id will be stored in the internal `$hash->{sid}`.
HTTPMOD will create a sorted list of steps (the numbers between sid and URL / Data / Header) and the loop through these steps and send the corresponding requests to the device. For each step a $sid in a Header or Post Data will be replaced with the current content of `$hash->{sid}`.
Using this feature, HTTPMOD can perform a forms based authentication and send user name, password or other necessary data to the device and save the session id for further requests.
If for one step not all of the URL, Data or Header Attributes are set, then HTTPMOD tries to use a `sidURL`, `sidData.*` or `sidHeader.*` Attribue (without the step number after sid). This way parts that are the same for all steps don't need to be defined redundantly.
To determine when this login procedure is necessary, HTTPMOD will first try to send a request without doing the login procedure. If the result contains an error that authentication is necessary, then a login is performed. To detect such an error in the HTTP response, you can again use a regular expression, JSON or XPath, this time with the attributes

- reAuthRegex
- reAuthJSON
- reAuthXPath
- reAuthXPath-Strict
- [gs]et[0-9]*ReAuthRegex
- [gs]et[0-9]*ReAuthJSON
- [gs]et[0-9]*ReAuthXPath
- [gs]et[0-9]*ReAuthXPath-Strict

reAuthJSON or reAuthXPath typically only extract one piece of data from a response. If the existance of the specified piece of data is sufficent to start a login procedure, then nothing more needs to be defined to detect this situation. If however the indicator is a status code that contains different values depending on a successful request and a failed request if a new authentication is needed, then you can combine things like reAuthJSON with reAuthRegex. In this case the regex is only matched to the data extracted by JSON (or XPath). This way you can easily extract the status code using JSON parsing and then specify the code that means "authentication needed" as a regular expression.
Example for a multi step login procedure:

`attr PM reAuthRegex /html/dummy_login.htm attr PM sidURL http://192.168.70.90/cgi-bin/webgui.fcgi?sid=$sid
attr PM sidHeader1 Content-Type: application/json
attr PM sid1IdRegex wui.init\('([^']+)'
attr PM sid2Data {"set" :{"9.17401.user" :"fhem" ,"9.17401.pass" :"password" }}
attr PM sid3Data {"set" :{"35.5062.value" :"128" }}
attr PM sid4Data {"set" :{"42.8026.code" :"pincode" }}
`

In this case HTTPMOD detects that a login is necessary by looking for the pattern /html/dummy_login.htm in the HTTP response. If it matches, it starts a login sequence. In the above example all steps request the same URL. In step 1 only the defined header is sent in an HTTP get request. The response will contain a session id that is extraced with the regex wui.init\('([^']+)'. In the next step this session id is sent in a post request to the same URL where tha post data contains a username and password. The a third and a fourth request follow that set a value and a code. The result will be a valid and authorized session id that can be used in other requests where $sid is part of a URL, header or post data and will be replaced with the session id extracted above.
In the special case where a session id is set as a HTTP-Cookie (with the header Set-cookie: in the HTTP response) HTTPMOD offers an even simpler way. With the attribute enableCookies a very basic cookie handling mechanism is activated that stores all cookies that the server sends to the HTTPMOD device and puts them back as cookie headers in the following requests.
For such cases no sidIdRegex and no $sid in a user defined header is necessary.

Parsing JSON

If a webservice delivers data in JSON format, HTTPMOD can directly parse JSON which might be easier in this case than definig regular expressions.
The next example shows the data that can be requested from a Poolmanager with the following partial configuration:

`define test2 HTTPMOD none 0
attr test2 get01Name Chlor
attr test2 getURL http://192.168.70.90/cgi-bin/webgui.fcgi
attr test2 getHeader1 Content-Type: application/json
attr test2 getHeader2 Accept: */*
attr test2 getData {"get" :["34.4008.value"]}
`

The data in the HTTP response looks like this:

            {
                "data": {
                        "34.4008.value": "0.25"
                },
                "status":       {
                        "code": 0
                },
                "event":        {
                        "type": 1,
                        "data": "48.30000.0"
                }
            }

the classic way to extract the value 0.25 into a reading with the name Chlor with a regex would have been

`attr test2 get01Regex 34.4008.value":[ \t]+"([\d\.]+)"`

with JSON you can write

`attr test2 get01JSON data_34.4008.value`

If you define an explicit json reading with the get01JSON or reading01JSON syntax and there is no full match, HTTPMOD will try to do a regex match using the defined string. If for example the json data contains an array like

`"modes":["Off","SimpleColor","RainbowChase","BobblySquares","Blobs","CuriousCat","Adalight","UDP","DMX"],`

a Configuration could be

`attr test2 get01Name ModesList attr test2 get01JSON modes`

The result will be treated as a list just like a list of XPath matches or Regex matches. So it will create readings ModlesList-1 ModesList-2 and so on as described above (simple Comfiguration).
You can also define a recombineExpr to recombine the match list into one reading e.g. as

`attr test2 reading01RecombineExpr join ",", @matchlist`

If you don't care about the naming of your readings, you can simply extract all JSON data with

`attr test2 extractAllJSON`

which would apply to all data read from this device and create the following readings out of the HTTP response shown above:

`data_34.4008.value 0.25
event_data 48.30000.0
event_type 1
status_code 0
`

or you can specify

`attr test2 get01ExtractAllJSON`

which would only apply to all data read as response to the get command defined as get01.

Parsing http / XML using xpath

Another alternative to regex parsing is the use of XPath to extract values from HTTP responses.
The following example shows how XML data can be parsed with XPath-Strict or HTML Data can be parsed with XPath.
Both work similar and the example uses XML Data parsed with the XPath-Strict option: If The XML data in the HTTP response looks like this:

`<root xmlns:foo="http://www.foo.org/" xmlns:bar="http://www.bar.org">
<actors>
<actor id="1">Peter X</actor>
<actor id="2">Charles Y</actor>
<actor id="3">John Doe</actor>
</actors>
</root>`

with XPath you can write

`attr htest reading01Name Actor
attr htest reading01XPath-Strict //actor[2]/text()`

This will create a reading with the Name "Actor" and the value "Charles Y".
Since XPath specifications can define several values / matches, HTTPMOD can also interpret these and store them in multiple readings:

`attr htest reading01Name Actor
attr htest reading01XPath-Strict //actor/text()`

will create the readings

`Actor-1 Peter X
Actor-2 Charles Y
Actor-3 John Doe`

Further replacements of URL, header or post data

sometimes it is helpful to dynamically change parts of a URL, HTTP header or post data depending on existing readings, internals or perl expressions at runtime.
HTTPMOD has two built in replacements: one for values passed to a set or get command and the other one for the session id.
Before a request is sent, the placeholder $val is replaced with the value that is passed in a set command or an optional value that can be passed in a get command (see getXTextArg). This value is internally stored in the internal "value" so it can also be used in a user defined replacement as explaind in this section.
The other built in replacement is for the session id. If a session id is extracted via a regex, JSON or XPath the it is stored in the internal "sid" and the placeholder $sid in a URL, header or post data is replaced by the content of thus internal. User defined replacement can exted this functionality and this might be needed to pass further variables to a server, a current date or other things.
To support this HTTPMOD offers user defined replacements that are as well applied to a request before it is sent to the server. A replacement can be defined with the attributes

`"replacement[0-9]*Regex "
"replacement[0-9]*Mode "
"replacement[0-9]*Value "
"[gs]et[0-9]*Replacement[0-9]*Value "`

A replacement always replaces a match of a regular expression. The way the replacement value is defined can be specified with the replacement mode. If the mode is `reading`, then the value is interpreted as the name of a reading of the same device or as device:reading to refer to another device. If the mode is `internal`, then the value is interpreted as the name of an internal of the same device or as device:internal to refer to another device.
The mode `text` will use the value as a static text and the mode `expression` will evaluate the value as a perl expression to compute the replacement. Inside such a replacement expression it is possible to refer to capture groups of the replacement regex.
The mode `key` will use a value from a key / value pair that is stored in an obfuscated form in the file system with the set storeKeyValue command. This might be useful for storing passwords.
Example:

`attr mydevice getData {"get" :["%%value%%.value"]}
attr mydevice replacement01Mode text
attr mydevice replacement01Regex %%value%%
attr mydevice get01Name Chlor
attr mydevice get01Replacement01Value 34.4008
attr mydevice get02Name Something
attr mydevice get02Replacement01Value 31.4024
attr mydevice get05Name profile
attr mydevice get05URL http://www.mydevice.local/getprofile?password=%%password%%
attr mydevice replacement02Mode key
attr mydevice replacement02Regex %%password%%
attr mydevice get05Replacement02Value password
`

defines that %%value%% will be replaced by a static text.
All Get commands will be HTTP post requests of a similar form. Only the %%value%% will be different from get to get.
The first get will set the reading named Chlor and for the request it will take the generic getData and replace %%value%% with 34.4008.
A second get will look the same except a different name and replacement value.
With the command `set storeKeyValue password geheim` you can store the password geheim in an obfuscated form in the file system. To use this password and send it in a request you can use the above replacement with mode key. The value password will then refer to the ofuscated string stored with the key password.
HTTPMOD has two built in replacements: One for session Ids and another one for the input value in a set command. The placeholder $sid is always replaced with the internal `$hash->{sid}` which contains the session id after it is extracted from a previous HTTP response. If you don't like to use the placeholder $sid the you can define your own replacement for example like:

`attr mydevice replacement01Mode internal
attr mydevice replacement01Regex %session%
attr mydevice replacement01Value sid
`

Now the internal `$hash->{sid}` will be used as a replacement for the placeholder %session%.
In the same way a value that is passed to a set-command can be put into a request with a user defined replacement. In this case the internal `$hash->{value}` will contain the value passed to the set command. It might even be a string containing several values that could be put into several different positions in a request by using user defined replacements.
The mode expression allows you to define your own replacement syntax:

`attr mydevice replacement01Mode expression
attr mydevice replacement01Regex {{([^}]+)}}
attr mydevice replacement01Value ReadingsVal("mydevice", $1, "")
attr mydevice getData {"get" :["{{temp}}.value"]}`

In this example any {{name}} in a URL, header or post data will be passed on to the perl function ReadingsVal which uses the string between {{}} as second parameter. This way one defined replacement can be used for many different readings.

replacing reading values when they have not been updated / the device did not respond

If a device does not respond then the values stored in readings will keep the same and only their timestamp shows that they are outdated. If you want to modify reading values that have not been updated for a number of seconds, you can use the attributes

`(reading|get)[0-9]*(-[0-9]+)?MaxAge
(reading|get)[0-9]*(-[0-9]+)?MaxAgeReplacementMode
(reading|get)[0-9]*(-[0-9]+)?MaxAgeReplacement
`

Every time the module tries to read from a device, it will also check if readings have not been updated for longer than the MaxAge attributes allow. If readings are outdated, the MaxAgeReplacementMode defines how the affected reading values should be replaced. MaxAgeReplacementMode can be `text`, `expression` or `delete`.
MaxAge specifies the number of seconds that a reading should remain untouched before it is replaced.
MaxAgeReplacement contains either a static text that is used as replacement value or a Perl expression that is evaluated to give the replacement value. This can be used for example to replace a temperature that has not bee updated for more than 5 minutes with the string "outdated - was 12":

`attr PM readingMaxAge 300
attr PM readingMaxAgeReplacement "outdated - was " . $val
attr PM readingMaxAgeReplacementMode expression`

The variable $val contains the value of the reading before it became outdated.
If the mode is delete then the reading will be deleted if it has not been updated for the defined time.
If you want to replace or delete a reading immediatley if a device doid not respond, simply set the maximum time to a number smaller than the update interval. Since the max age is checked after a HTTP request was either successful or it failed, the reading will always contain the read value or the replacement after a failed update.

Set-Commands

As defined by the attributes set.*Name
If you set the attribute enableControlSet to 1, the following additional built in set commands are available:

- interval
set new interval time in seconds and restart the timer
- reread
request the defined URL and try to parse it just like the automatic update would do it every Interval seconds without modifying the running timer.
- stop
stop interval timer.
- start
restart interval timer to call GetUpdate after interval seconds
- upgradeAttributes
convert the attributes for this device from the old syntax to the new one.
atributes with the description "this attribute should not be used anymore" or similar will be translated to the new syntax, e.g. readingsName1 to reading01Name.
- storeKeyValue
stores a key value pair in an obfuscated form in the file system. Such values can then be used in replacements where the mode is "key" e.g. to avoid storing passwords in the configuration in clear text

Get-Commands

as defined by the attributes get.*Name

Attributes

- do_not_notify
- readingFnAttributes
- reading[0-9]+Name
the name of a reading to extract with the corresponding readingRegex, readingJSON, readingXPath or readingXPath-Strict
Please note that the old syntax readingsName.* does not work with all features of HTTPMOD and should be avoided. It might go away in a future version of HTTPMOD.
- (get|set)[0-9]+Name
Name of a get or set command to be defined. If the HTTP response that is received after the command is parsed with an individual parse option then this name is also used as a reading name. Please note that no individual parsing needs to be defined for a get or set. If no regex, XPath or JSON is specified for the command, then HTTPMOD will try to parse the response using all the defined readingRegex, reading XPath or readingJSON attributes.
- (get|set|reading)[0-9]+Regex
If this attribute is specified, the Regex defined here is used to extract the value from the HTTP Response and assign it to a Reading with the name defined in the (get|set|reading)[0-9]+Name attribute.
If this attribute is not specified for an individual Reading or get or set but without the numbers in the middle, e.g. as getRegex or readingRegex, then it applies to all the other readings / get / set commands where no specific Regex is defined.
The value to extract should be in a capture group / sub expression e.g. ([\d\.]+) in the above example. Multiple capture groups will create multiple readings (see explanation above)
Using this attribute for a set command (setXXRegex) only makes sense if you want to parse the HTTP response to the HTTP request that the set command sent by defining the attribute setXXParseResponse.
Please note that the old syntax readingsRegex.* does not work with all features of HTTPMOD and should be avoided. It might go away in a future version of HTTPMOD. If for get or set commands neither a generic Regex attribute without numbers nor a specific (get|set)[0-9]+Regex attribute is specified and also no XPath or JSON parsing specification is given for the get or set command, then HTTPMOD tries to use the parsing definitions for general readings defined in reading[0-9]+Name, reading[0-9]+Regex or XPath or JSON attributes and assigns the Readings that match here.
- (get|set|reading)[0-9]+RegOpt
Lets the user specify regular expression modifiers. For example if the same regular expression should be matched as often as possible in the HTTP response, then you can specify RegOpt g which will case the matching to be done as /regex/g
The results will be trated the same way as multiple capture groups so the reading name will be extended with -number. For other possible regular expression modifiers see http://perldoc.perl.org/perlre.html#Modifiers
- (get|set|reading)[0-9]+XPath
defines an xpath to one or more values when parsing HTML data (see examples above)
Using this attribute for a set command only makes sense if you want to parse the HTTP response to the HTTP request that the set command sent by defining the attribute setXXParseResponse.
- get|set|reading[0-9]+XPath-Strict
defines an xpath to one or more values when parsing XML data (see examples above)
Using this attribute for a set command only makes sense if you want to parse the HTTP response to the HTTP request that the set command sent by defining the attribute setXXParseResponse.
- (get|set|reading)[0-9]+AutoNumLen
In cases where a regular expression or an XPath results in multiple results and these results are stored in a common reading name with extension -number, then you can modify the format of this number to have a fixed length with leading zeros. AutoNumLen 3 for example will lead to reading names ending with -001 -002 and so on.
- (reading|get|set)[0-9]*AlwaysNum
if set to 1 this attributes forces reading names to end with a -1, -01 (depending on the above described AutoNumLen) even if just one value is parsed.
- get|set|reading[0-9]+JSON
defines a path to the JSON object wanted by concatenating the object names. See the above example.
If you don't know the paths, then start by using extractAllJSON and the use the names of the readings as values for the JSON attribute.
Please don't forget to also specify a name for a reading, get or set. Using this attribute for a set command only makes sense if you want to parse the HTTP response to the HTTP request that the set command sent by defining the attribute setXXParseResponse.
- (get|set|reading)[0-9]*RecombineExpr
defines an expression that is used in an eval to compute one reading value out of the list of matches.
This is supposed to be used for regexes or xpath specifications that produce multiple results if only one result that combines them is wanted. The list of matches will be in the variable @matchlist.
Using this attribute for a set command only makes sense if you want to parse the HTTP response to the HTTP request that the set command sent by defining the attribute setXXParseResponse.
- get[0-9]*CheckAllReadings
this attribute modifies the behavior of HTTPMOD when the HTTP Response of a get command is parsed.
If this attribute is set to 1, then additionally to the matching of get specific regexe (get[0-9]*Regex), XPath or JSON also all the reading names and parse definitions defined in Reading[0-9]+Name and Reading[0-9]+Regex, XPath or JSON attributes are checked and if they match, the coresponding Readings are assigned as well.
This is automatically done if a get or set command is defined without its own parse attributes.
- (get|reading)[0-9]*OExpr
defines an optional expression that is used in an eval to compute / format a readings value after parsing an HTTP response
The raw value from the parsing will be in the variable $val.
If specified as readingOExpr then the attribute value is a default for all other readings that don't specify an explicit reading[0-9]*Expr.
Please note that the old syntax readingsExpr.* does not work with all features of HTTPMOD and should be avoided. It might go away in a future version of HTTPMOD.
- (get|reading)[0-9]*Expr
This is the old syntax for (get|reading)[0-9]*OExpr. It should be replaced by (get|reading)[0-9]*OExpr. The set command upgradeAttributes which becomes visible when the attribute enableControlSet is set to 1, can do this renaming automatically.
- (get|reading)[0-9]*OMap
Map that defines a mapping from raw value parsed to visible values like "0:mittig, 1:oberhalb, 2:unterhalb".
If specified as readingOMap then the attribute value is a default for all other readings that don't specify an explicit reading[0-9]*Map.
The individual options in a map are separated by a komma and an optional space. Spaces are allowed to appear in a visible value however kommas are not possible.
- (get|reading)[0-9]*Map
This is the old syntax for (get|reading)[0-9]*OMap. It should be replaced by (get|reading)[0-9]*OMap. The set command upgradeAttributes which becomes visible when the attribute enableControlSet is set to 1, can do this renaming automatically.
- (get|set|reading)[0-9]*Format
Defines a format string that will be used in sprintf to format a reading value.
If specified without the numbers in the middle e.g. as readingFormat then the attribute value is a default for all other readings that don't specify an explicit reading[0-9]*Format. Using this attribute for a set command only makes sense if you want to parse the HTTP response to the HTTP request that the set command sent by defining the attribute setXXParseResponse.
- (get|set|reading)[0-9]*Decode
defines an encoding to be used in a call to the perl function decode to convert the raw data string read from the device to a reading. This can be used if the device delivers strings in an encoding like cp850 instead of utf8.
If your reading values contain Umlauts and they are shown as strange looking icons then you probably need to use this feature. Using this attribute for a set command only makes sense if you want to parse the HTTP response to the HTTP request that the set command sent by defining the attribute setXXParseResponse.
- (get|set|reading)[0-9]*Encode
defines an encoding to be used in a call to the perl function encode to convert the raw data string read from the device to a reading. This can be used if the device delivers strings in an encoding like cp850 and after decoding it you want to reencode it to e.g. utf8. If your reading values contain Umlauts and they are shown as strange looking icons then you probably need to use this feature. Using this attribute for a set command only makes sense if you want to parse the HTTP response to the HTTP request that the set command sent by defining the attribute setXXParseResponse.
- (get|set)[0-9]*URL
URL to be requested for the get or set command. If this option is missing, the URL specified during define will be used.
- (get|set)[0-9]*Data
optional data to be sent to the device as POST data when the get oer set command is executed. if this attribute is specified, an HTTP POST method will be sent instead of an HTTP GET
- (get|set)[0-9]*NoData
can be used to override a more generic attribute that specifies POST data for all get commands. With NoData no data is sent and therefor the request will be an HTTP GET.
- (get|set)[0-9]*Header.*
optional HTTP Headers to be sent to the device when the get or set command is executed
- requestHeader.*
Define an optional additional HTTP Header to set in the HTTP request
- requestData
optional POST Data to be sent in the request. If not defined, it will be a GET request as defined in HttpUtils used by this module
- get[0-9]+Poll
if set to 1 the get is executed automatically during the normal update cycle (after the interval provided in the define command has elapsed)
- get[0-9]+PollDelay
if the value should not be read in each iteration (after the interval given to the define command), then a minimum delay can be specified with this attribute. This has only an effect if the above Poll attribute has also been set. Every time the update function is called, it checks if since this get has been read the last time, the defined delay has elapsed. If not, then it is skipped this time.
PollDelay can be specified as seconds or as x[0-9]+ which means a multiple of the interval in the define command.
- (get|set)[0-9]*TextArg
For a get command this defines that the command accepts a text value after the option name. By default a get command doesn't accept optional values after the command name. If TextArg is specified and a value is passed after the get name then this value can then be used in a request URL, header or data as replacement for $val or in a user defined replacement that uses the internal "value" ($hash->{value}).
If used for a set command then it defines that the value to be set doesn't require any validation / conversion. The raw value is passed on as text to the device. By default a set command expects a numerical value or a text value that is converted to a numeric value using a map.
- set[0-9]+Min
Minimum value for input validation.
- set[0-9]+Max
Maximum value for input validation.
- set[0-9]+IExpr
Perl Expression to compute the raw value to be sent to the device from the input value passed to the set.
- set[0-9]+Expr
This is the old syntax for (get|reading)[0-9]*IExpr. It should be replaced by (get|reading)[0-9]*IExpr. The set command upgradeAttributes which becomes visible when the attribute enableControlSet is set to 1, can do this renaming automatically.
- set[0-9]+IMap
Map that defines a mapping from raw to visible values like "0:mittig, 1:oberhalb, 2:unterhalb". This attribute atomatically creates a hint for FhemWEB so the user can choose one of the visible values and HTTPMOD sends the raw value to the device.
- set[0-9]+Map
This is the old syntax for (get|reading)[0-9]*IMap. It should be replaced by (get|reading)[0-9]*IMap. The set command upgradeAttributes which becomes visible when the attribute enableControlSet is set to 1, can do this renaming automatically.
- set[0-9]+Hint
Explicit hint for fhemWEB that will be returned when set ? is seen.
- set[0-9]*NoArg
Defines that this set option doesn't require arguments. It allows sets like "on" or "off" without further values.
- set[0-9]*ParseResponse
defines that the HTTP response to the set will be parsed as if it was the response to a get command.
- (get|set)[0-9]*URLExpr
Defines a Perl expression to specify the HTTP Headers for this request. This overwrites any other header specification and should be used carefully only if needed. The original Header is availabe as $old. Typically this feature is not needed and it might go away in future versions of HTTPMOD. Please use the "replacement" attributes if you want to pass additional variable data to a web service.
- (get|set)[0-9]*DatExpr
Defines a Perl expression to specify the HTTP Post data for this request. This overwrites any other post data specification and should be used carefully only if needed. The original Data is availabe as $old. Typically this feature is not needed and it might go away in future versions of HTTPMOD. Please use the "replacement" attributes if you want to pass additional variable data to a web service.
- (get|set)[0-9]*HdrExpr
Defines a Perl expression to specify the URL for this request. This overwrites any other URL specification and should be used carefully only if needed. The original URL is availabe as $old. Typically this feature is not needed and it might go away in future versions of HTTPMOD. Please use the "replacement" attributes if you want to pass additional variable data to a web service.
- set[0-9]*ReAuthRegex
Regex that will detect when a session has expired during a set operation and a new login needs to be performed. It works like the global reAuthRegex but is used for set operations.
- reAuthRegex
regular Expression to match an error page indicating that a session has expired and a new authentication for read access needs to be done. This attribute only makes sense if you need a forms based authentication for reading data and if you specify a multi step login procedure based on the sid.. attributes.
This attribute is used for all requests. For set operations you can however specify individual reAuthRegexes with the set[0-9]*ReAuthRegex attributes.
- sid[0-9]*URL
different URLs or one common URL to be used for each step of an optional login procedure.
- sid[0-9]*IdRegex
different Regexes per login procedure step or one common Regex for all steps to extract the session ID from the HTTP response
- sid[0-9]*Data.*
data part for each step to be sent as POST data to the corresponding URL
- sid[0-9]*Header.*
HTTP Headers to be sent to the URL for the corresponding step
- sid[0-9]*IgnoreRedirects
tell HttpUtils to not follow redirects for this authentication request
- clearSIdBeforeAuth
will set the session id to "" before doing the authentication steps
- authRetries
number of retries for authentication procedure - defaults to 1
- replacement[0-9]*Regex
Defines a replacement to be applied to an HTTP request header, data or URL before it is sent. This allows any part of the request to be modified based on a reading, an internal or an expression. The regex defines which part of a header, data or URL should be replaced. The replacement is defined with the following attributes:
- replacement[0-9]*Mode
Defines how the replacement should be done and what replacementValue means. Valid options are text, reading, internal and expression.
- replacement[0-9]*Value
Defines the replacement. If the corresponding replacementMode is `text`, then value is a static text that is used as the replacement.
If replacementMode is `reading` then Value can be the name of a reading of this device or it can be a reading of a different device referred to by devicename:reading.
If replacementMode is `internal` the Value can be the name of an internal of this device or it can be an internal of a different device referred to by devicename:internal.
If replacementMode is `expression` the the Value is treated as a Perl expression that computes the replacement value. The expression can use $1, $2 and so on to refer to capture groups of the corresponding regex that is matched against the original URL, header or post data.
If replacementMode is `key` then the module will use a value from a key / value pair that is stored in an obfuscated form in the file system with the set storeKeyValue command. This might be useful for storing passwords.
- [gs]et[0-9]*Replacement[0-9]*Value
This attribute can be used to override the replacement value for a specific get or set.
- get|reading[0-9]*MaxAge
Defines how long a reading is valid before it is automatically overwritten with a replacement when the read function is called the next time.
- get|reading[0-9]*MaxAgeReplacement
specifies the replacement for MaxAge - either as a static text, the name of a reading / internal or as a perl expression.
If MaxAgeReplacementMode is `reading` then the value of MaxAgeReplacement can be the name of a reading of this device or it can be a reading of a different device referred to by devicename:reading.
If MaxAgeReplacementMode is `internal` the value of MaxAgeReplacement can be the name of an internal of this device or it can be an internal of a different device referred to by devicename:internal.
- get|reading[0-9]*MaxAgeReplacementMode
specifies how the replacement is interpreted: can be text, reading, internal, expression and delete.
- get|reading[0-9]*DeleteIfUnmatched
If set to 1 this attribute causes certain readings to be deleted when the parsing of the website does not match the specified reading. Internally HTTPMOD remembers which kind of operation created a reading (update, Get01, Get02 and so on). Specified readings will only be deleted if the same operation does not parse this reading again. This is especially useful for parsing that creates several matches / readings and this number of matches can vary from request to request. For example if reading01Regex creates 4 readings in one update cycle and in the next cycle it only matches two times then the readings containing the remaining values from the last round will be deleted.
Please note that this mechanism will not work in all cases after a restart. Especially when a get definition does not contain its own parsing definition but ExtractAllJSON or relies on HTTPMOD to use all defined reading.* attributes to parse the responsee to a get command, old readings might not be deleted after a restart of fhem.
- get|reading[0-9]*DeleteOnError
If set to 1 this attribute causes certain readings to be deleted when the website can not be reached and the HTTP request returns an error. Internally HTTPMOD remembers which kind of operation created a reading (update, Get01, Get02 and so on). Specified readings will only be deleted if the same operation returns an error.
The same restrictions as for DeleteIfUnmatched apply regarding a fhem restart.
- httpVersion
defines the HTTP-Version to be sent to the server. This defaults to 1.0.
- sslVersion
defines the SSL Version for the negotiation with the server. The attribute is evaluated by HttpUtils. If it is not specified, HttpUtils assumes SSLv23:!SSLv3:!SSLv2
- sslArgs
defines a list that is converted to a key / value hash and gets passed to HttpUtils. To avoid certificate validation for broken servers you can for example specify `attr myDevice sslArgs SSL_verify_mode,SSL_VERIFY_NONE`
- noShutdown
pass the noshutdown flag to HTTPUtils for webservers that need it (some embedded webservers only deliver empty pages otherwise)
- disable
stop communication with the Web_Server with HTTP requests while this attribute is set to 1
- enableControlSet
enables the built in set commands interval, stop, start, reread, upgradeAttributes, storeKeyValue.
- enableCookies
enables the built cookie handling if set to 1. With cookie handling each HTTPMOD device will remember cookies that the server sets and send them back to the server in the following requests. This simplifies session magamenet in cases where the server uses a session ID in a cookie. In such cases enabling Cookies should be sufficient and no sidRegex and no manual definition of a Cookie Header should be necessary.
- showMatched
if set to 1 then HTTPMOD will create a reading with the name MATCHED_READINGS that contains the names of all readings that could be matched in the last request.
- showError
if set to 1 then HTTPMOD will create a reading and event with the Name LAST_ERROR that contains the error message of the last error returned from HttpUtils.
- timeout
time in seconds to wait for an answer. Default value is 2
- queueDelay
HTTP Requests will be sent from a queue in order to avoid blocking when several Requests have to be sent in sequence. This attribute defines the delay between calls to the function that handles the send queue. It defaults to one second.
- queueMax
Defines the maximum size of the send queue. If it is reached then further HTTP Requests will be dropped and not be added to the queue
- minSendDelay
Defines the minimum time between two HTTP Requests.
- alignTime
Aligns each periodic read request for the defined interval to this base time. This is typcally something like 00:00 (see the Fhem at command)
- enableXPath
This attribute should no longer be used. Please specify an HTTP XPath in the dedicated attributes shown above.
- enableXPath-Strict
This attribute should no longer be used. Please specify an XML XPath in the dedicated attributes shown above.
- parseFunction1 and parseFunction2
These functions allow an experienced Perl / Fhem developer to plug in his own parsing functions.
Please look into the module source to see how it works and don't use them if you are not sure what you are doing.
- Remarks regarding the automatically created userattr entries
Fhemweb allows attributes to be edited by clicking on them. However this does not work for attributes that match to a wildcard attribute. To circumvent this restriction HTTPMOD automatically adds an entry for each instance of a defined wildcard attribute to the device userattr list. E.g. if you define a reading[0-9]Name attribute as reading01Name, HTTPMOD will add reading01Name to the device userattr list. These entries only have the purpose of making editing in Fhemweb easier.

Author's notes

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

### HTTPSRV

Provides a mini HTTP server plugin for FHEMWEB. It serves files from a given directory. It optionally accepts a query string to set readings of this device if an attribute allows the given reading

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

Define

`define <name> <infix> <directory> <friendlyname>`
Defines the HTTP server. `<infix>` is the portion behind the FHEMWEB base URL (usually `http://hostname:8083/fhem`), `<directory>` is the absolute path the files are served from, and `<friendlyname>` is the name displayed in the side menu of FHEMWEB.

Example:

`define myJSFrontend HTTPSRV jsf /usr/share/jsfrontend My little frontend`
or
`define kindleweb HTTPSRV kindle /opt/fhem/kindle Kindle Web
attr kindleweb readings KindleBatt`

Set

n/a

Attributes

- directoryindex: if the request is sent with no filename, i.e. the infix (with or without trailing slash) only, the file given in this attribute is loaded. Defaults to `index.html`.
- readings: a comma separated list of reading names. If the request ends with a querystring like `?Batt=43` and an attribute is set like `attr kindleweb readings Batt`, then a reading with the Name of this Attribute (here Batt) is created with the value from the request.

Usage information

The above example on `http://hostname:8083/fhem` will return the file `/usr/share/jsfrontend/foo.html` for `http://hostname:8083/fhem/jsf/foo.html`. If no filename is given, the filename prescribed by the `directoryindex` attribute is returned.

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

### HUEBridge

Module to access the bridge of the phillips hue lighting system.
The actual hue bulbs, living colors or living whites devices are defined as HUEDevice devices.
All newly found devices and groups are autocreated at startup and added to the room HUEDevice.
Notes:

- This module needs `JSON`.
  Please install with '`cpan install JSON`' or your method of choice.

Define

`define <name> HUEBridge [<host>] [<interval>]`
Defines a HUEBridge device with address <host>.
If [<host>] is not given the module will try to autodetect the bridge with the hue portal services.
The bridge status will be updated every <interval> seconds. The default and minimum is 60.
After a new bridge is created the pair button on the bridge has to be pressed.
Examples:

`define bridge HUEBridge 10.0.1.1`

Get

- lights
  list the lights known to the bridge.
- groups
  list the groups known to the bridge.
- scenes [detail]
  list the scenes known to the bridge.
- rule <id>
  list the rule with <id>.
- rules [detail]
  list the rules known to the bridge.
- sensors [detail]
  list the sensors known to the bridge.
- whitelist
  list the whitlist of the bridge.

Set

- autocreate
  Create fhem devices for all bridge devices.
- autodetect
  Initiate the detection of new ZigBee devices. After aproximately one minute any newly detected devices can be listed with `get <bridge> devices` and the corresponding fhem devices can be created by `set <bridge> autocreate`.
- delete <name>|<id>
  Deletes the given device in the bridge and deletes the associated fhem device.
- creategroup <name> <lights>
  Create a group out of <lights> in the bridge. The lights are given as a comma sparated list of fhem device names or bridge light numbers.
- deletegroup <name>|<id>
  Deletes the given group in the bridge and deletes the associated fhem device.
- savescene <name> <lights>
  Create a scene from the current state of <lights> in the bridge. The lights are given as a comma sparated list of fhem device names or bridge light numbers.
- modifyscene <id> <light> <light-args>
  Modifys the given scene in the bridge.
- scene <id>
  Recalls the scene with the given id.
- createrule <name> <conditions&actions json>
  Creates a new rule in the bridge.
- deleterule <id>
  Deletes the given rule in the bridge.
- createsensor <name> <type> <uniqueid> <swversion> <modelid>
  Creates a new CLIP (IP) sensor in the bridge.
- deletesensor <id>
  Deletes the given sensor in the bridge and deletes the associated fhem device.
- configsensor <id> <json>
  Write sensor config data.
- setsensor <id> <json>
  Write CLIP sensor status data.
- deletewhitelist <key>
  Deletes the given key from the whitelist in the bridge.
- touchlink
  perform touchlink action
- checkforupdate
  perform checkforupdate action
- statusRequest
  Update bridge status.
- swupdate
  Update bridge firmware. This command is only available if a new firmware is available (indicated by updatestate with a value of 2. The version and release date is shown in the reading swupdate.
  A notify of the form `define HUEUpdate notify bridge:swupdate.* {...}` can be used to be informed about available firmware updates.

Attributes

- disable
- disabledForIntervals
- pollDevices
  1 -> the bridge will poll all lights in one go instead of each device polling itself independently
  2 -> the bridge will poll all devices in one go instead of each device polling itself independently
  default is 1.
- queryAfterSet
  the bridge will request the real device state after a set command. default is 1.
- noshutdown
  Some bridge devcies require a different type of connection handling. raspbee/deconz only works if the connection is not immediately closed, the phillips hue bridge works better if the connection is immediately closed. This module tries to autodetect the bridge device type. the type of connection handling can be seen in the noshutdown internal and can be overwritten with the noshutdown attribute.

### HUEDevice

Define

`define <name> HUEDevice [group|sensor] <id> [<interval>]`
Defines a device connected to a HUEBridge.
This can be a hue bulb, a living colors light or a living whites bulb or dimmer plug.
The device status will be updated every <interval> seconds. 0 means no updates. The default and minimum is 60 if the IODev has not set pollDevices to 1. The default ist 0 if the IODev has set pollDevices to 1. Groups are updated only on definition and statusRequest
Examples:

`define bulb HUEDevice 1`
`define LC HUEDevice 2`
`define allLights HUEDevice group 0`

Readings

- bri
  the brightness reported from the device. the value can be betwen 1 and 254
- colormode
  the current colormode
- ct
  the colortemperature in mireds and kelvin
- hue
  the current hue
- pct
  the current brightness in percent
- onoff
  the current on/off state as 0 or 1
- sat
  the current saturation
- xy
  the current xy color coordinates
- state
  the current state
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]
- xy <x>,<y> [<ramp-time>]
  set the xy color coordinates to <x>,<y>
- alert [none|select|lselect]
- effect [none|colorloop]
- transitiontime <time>
  set the transitiontime to <time> 1/10s
- rgb <rrggbb>
  set the color to (the nearest equivalent of) <rrggbb>
- delayedUpdate
- immediateUpdate
- savescene <id>
- deletescene <id>
- scene
- lights <lights>
  Only valid for groups. Changes the list of lights in this group. The lights are given as a comma sparated list of fhem device names or bridge light numbers.
- rename <new name>
  Renames the device in the bridge and changes the fhem alias.
- 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
- createActionReadings
  create readings for the last action in group devices
- ignoreReachable
  ignore the reachable state that is reported by the hue bridge. assume the device is allways reachable.
- setList
  The list of know set commands for sensor type devices. one command per line, eg.: `
  attr mySensor setList present:{<json>}\
  absent:{<json>}`
- subType
  extcolordimmer -> device has rgb and color temperatur control
  colordimmer -> device has rgb controll
  ctdimmer -> device has color temperature control
  dimmer -> device has brightnes controll
  switch -> device has on/off controll
- 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 `{(HUEDevice_devStateIcon($name),"toggle")}` to show device color as default in room overview.
- webCmd
  will be initialized to a device specific value according to subType.

### HXB

Define

`define <name> HXB`
Defines a Hexabus. You need one Hexabus to receive multicast messages from Hexabus devices. Have a look at the Hexabus wiki for more information on Hexabus.
You need the perl modules IO::Socket::Multicast6 and Digest::CRC. Under Debian and its derivatives they are installed with `apt-get install libio-socket-multicast6-perl libdigest-crc-perl`.

### HXBDevice

Define

`define <name> HXB <IPv6Address>`
Defines a Hexabus device at the IPv6 address <IPv6Address>. You need one Hexabus to receive multicast messages from Hexabus devices. Have a look at the Hexabus wiki for more information on Hexabus.
Example: `define myPlug fd01:1::50:c4ff:fe04:81ad`

### Heating Control

Define

`define <name> Heating_Control <device> [<language>] [weekdays] <profile> [<command>|<condition>]`
to set a weekly profile for <device>, eg. a heating sink.
You can define different switchingtimes for every day.
The new temperature is sent to the <device> automatically with
`set <device> (desired-temp|desiredTemperature) <temp>`
Because of the fhem-type of structures, a structures of heating sinks is sent "desired-temp": Use an explicit command if you have structures of MAX heating thermostats.
If you have defined a <condition> and this condition is false if the switchingtime has reached, no command will executed.
A other case is to define an own perl command with <command>.

The following parameter are defined:

device
The device to switch at the given time.

language
Specifies the language used for definition and profiles. de,en,fr are possible. The parameter is optional.

weekdays
Specifies the days for all timer in the Heating_Control. The parameter is optional. For details see the weekdays part in profile.

profile
Define the weekly profile. All timings are separated by space. A switchingtime is defined by the following example:

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

weekdays: optional, if not set every day of the week is used.
Otherwise you can define a day with its number or its shortname.

- 0,su sunday
- 1,mo monday
- 2,tu tuesday
- 3,we wednesday
- 4 ...
- 7,$we weekend ($we)
- 8,!$we weekday (!$we)

It is possible to define $we or !$we in daylist to easily allow weekend an holiday. $we !$we are coded as 7 8, when using a numeric daylist.
time:define the time to switch, format: HH:MM:[SS](HH in 24 hour format) or a Perlfunction like {sunrise_abs()}. Within the {} you can use the variable $date(epoch) to get the exact switchingtimes of the week. Example: {sunrise_abs_dat($date)}
parameter:the temperature to be set, using a float with mask 99.9 or a sybolic value like eco or comfort - whatever your thermostat understands. The symbolic value can be added an additional parameter: dayTemp:16 night-temp:15. See examples

command
If no condition is set, all the rest is interpreted as a command. Perl-code is setting up by the well-known Block with {}.
Note: if a command is defined only this command is executed. In case of executing a "set desired-temp" command, you must define the hole commandpart explicitly by yourself.
The following parameter are replaced:

1. $NAME => the device to switch
2. $EVENT => the new temperature

condition
if a condition is defined you must declare this with () and a valid perl-code.
The returnvalue must be boolean.
The parameter $NAME and $EVENT will be interpreted.

Examples:

`define HCB Heating_Control Bad_Heizung 12345|05:20|21 12345|05:25|comfort 17:20|21 17:25|eco`
Mo-Fr are setting the temperature at 05:20 to 21°C, and at 05:25 to comfort. Every day will be set the temperature at 17:20 to 21°C and 17:25 to eco.

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

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

`define HCW Heating_Control WZ_Heizung en Su-Fr|{sunrise_abs()}|21 Mo-Fr|{sunset_abs()}|16`
The device is switched at sunrise/sunset. Language: english.

`define HCW Heating_Control WZ_Heizung en Mo-Fr|{myFunction}|night-temp:18 Mo-Fr|{myFunction()}|dayTemp:16`
The is switched at time myFunction(). It is sent the Command "night-temp 18" and "dayTemp 16".

If you want to have set all Heating_Controls their current value (after a temperature lowering phase holidays) you can call the function Heating_Control_SetTemp("HC-device") or Heating_Control_SetAllTemps().
This call can be automatically coupled to a dummy by a notify:
`define HeizStatus2 notify Heating:. * {Heating_Control_SetAllTemps()}`

Some definitions without comment: ``

            define hc    Heating_Control  HeizungKueche de        7|23:35|25        34|23:30|22 23:30|16 23:15|22     8|23:45|16
            define hc    Heating_Control  HeizungKueche de        fr,$we|23:35|25   34|23:30|22 23:30|16 23:15|22    12|23:45|16
            define hc    Heating_Control  HeizungKueche de        20:35|25          34|14:30|22 21:30|16 21:15|22    12|23:00|16

            define hw    Heating_Control  HeizungKueche de        mo-so, $we|{sunrise_abs_dat($date)}|18      mo-so, $we|{sunset_abs_dat($date)}|22
            define ht    Heating_Control  HeizungKueche de        mo-so,!$we|{sunrise_abs_dat($date)}|18      mo-so,!$we|{sunset_abs_dat($date)}|22

            define hh    Heating_Control  HeizungKueche de        {sunrise_abs_dat($date)}|19           {sunset_abs_dat($date)}|21
            define hx    Heating_Control  HeizungKueche de        22:35|25  23:00|16

the list of days can be set globaly for the whole Heating_Control:

``

            define HeizungWohnen_an_wt    Heating_Control HeizungWohnen de  !$we     09:00|19  (heizungAnAus("Ein"))
            define HeizungWohnen_an_we    Heating_Control HeizungWohnen de   $we     09:00|19  (heizungAnAus("Ein"))
            define HeizungWohnen_an_we    Heating_Control HeizungWohnen de   78      09:00|19  (heizungAnAus("Ein"))
            define HeizungWohnen_an_we    Heating_Control HeizungWohnen de   57      09:00|19  (heizungAnAus("Ein"))
            define HeizungWohnen_an_we    Heating_Control HeizungWohnen de  fr,$we   09:00|19  (heizungAnAus("Ein"))

An example to be able to temporarily boost the temperature for one hour: `

          define hc Heating_Control HeatingBath de !$we|05:00|{HC_WithBoost(23,"HeatingBath")} $we|07:00|{HC_WithBoost(23,"HeatingBath")} 23:00|{HC_WithBoost(20,"HeatingBath")}

` and using a "HeatingBath_Boost" dummy variable: `

          define HeatingBath_Boost dummy
          attr HeatingBath_Boost setList state:0,23,24,25
          attr HeatingBath_Boost webCmd state
          define di_ResetBoostBath DOIF ([HeatingBath_Boost] > 0)
             ({Heating_Control_SetAllTemps()}, defmod di_ResetBoostBath_Reset at +01:00:00 set HeatingBath_Boost 0)
            DOELSE
             ({Heating_Control_SetAllTemps()})
          attr di_ResetBoostBath do always

` and the perl subroutine in 99_myUtils.pm (or the like) `

          sub HC_BathWithBoost {
            my $numParams = @_;
            my ($degree, $boostPrefix) = @_;
            if ($numParams > 1)
             {
             my $boost = ReadingsVal($boostPrefix . "_Boost", "state", "0");
             return $boost if ($boost =~ m/^\d+$/) && ($boost > 0); # boost?
             }
            return $degree; # otherwise return given temperature
          }

` Now you can set "HeatingBath_Boost" in the web interface for a one-hour boost of 3 degrees in the bath. (you can trigger that using the PRESENCE function using your girlfriend's device... grin). Easy to extend this with a vacation timer using another dummy variable, here `VacationTemp`.
Then you can use the command `defmod defVacationEnd at 2016-12-30T00:00:00 set VacationTemp off, {Heating_Control_SetAllTemps()}` to stop the vacation temperature before you return in january 2017 and let the appartment heat up again. `

          sub HC_BathWithBoost($) {
            my $vacation = ReadingsVal("VacationTemp", "state", "unfortunately not on vacation");
            return $vacation if $vacation =~ /^(\d+|eco)$/; # set vacation temperature if given

            my $numParams = @_;
            my ($degree, $boostPrefix) = @_;
            if ($numParams > 1)
             {
             my $boost = ReadingsVal($boostPrefix . "_Boost", "state", "0");
             return $boost if ($boost =~ m/^\d+$/) && ($boost > 0); # boost?
             }
          }

` Pray that the device does not restart during your vacation, as the `define defVacationEnd ... at` is volatile and will be lost at restart!

Set

N/A

Get

N/A

Attributes

- delayedExecutionCond
  defines a delay Function. When returning true, the switching of the device is delayed until the function retruns a false value. The behavior is just like a windowsensor.
  Example:

          attr hc delayedExecutionCond isDelayed("%HEATING_CONTROL","%WEEKDAYTIMER","%TIME","%NAME","%EVENT")

  the parameters %HEATING_CONTROL(timer name) %TIME %NAME(device name) %EVENT are replaced at runtime by the correct value.
  Example of a function:

          sub isDelayed($$$$$) {
             my($hc, $wdt, $tim, $nam, $event ) = @_;

             my $theSunIsStillshining = ...

             return ($tim eq "16:30" && $theSunIsStillshining) ;
          }

- switchInThePast
  defines that the depending device will be switched in the past in definition and startup phase when the device is not recognized as a heating. Heatings are always switched in the past.
- disable
- event-on-update-reading
- event-on-change-reading
- stateFormat
- windowSensor
  Defines a list of window sensors. When one of its window state readings is open the aktual switch is delayed.

### Hideki

The Hideki module is a module for decoding weather sensors, which use the hideki protocol. Known brands are Bresser, Cresta, TFA and Hama.
Supported Brands

- Hama
- Bresser
- TFA Dostman
- Arduinos with remote Sensor lib from Randy Simons
- Cresta
- Hideki
- all other devices, which use the Hideki protocol

Please note, currently temp/hum devices are implemented. Please report data for other sensortypes. Define

`define <name> Hideki <code>`
<code> is the address of the sensor device and is build by the sensor type and the channelnumber (1 to 5) or if the attribute longid is specfied an autogenerated address build when inserting the battery (this adress will change every time changing the battery).
If autocreate is enabled, the device will be defined via autocreate. This is also the preferred mode of defining such a device.

Generated readings

- state (T:x H:y B:z)
- temperature (°C)
- humidity (0-100)
- battery (ok or low)
- channel (The Channelnumber (number if)

Set

N/A

Get

N/A

Attributes

- do_not_notify
- eventMap
- ignore
- showtime
- readingFnAttributes

### HourCounter

Define
`define <name> HourCounter <pattern_for_ON> [<pattern_for_OFF>]`
Hourcounter can detect both the activiy-time and the inactivity-time of a property.
The "pattern_for_ON" identifies the events, that signal the activity of the desired property.
The "pattern_for_OFF" identifies the events, that signal the inactivity of the desired property.
If "pattern_for_OFF" is not defined, any matching event of "patter_for_ON" will be counted.
Otherwise only the rising edges of "pattern_for_ON" will be counted.
This means a "pattern_for_OFF"-event must be detected before a "pattern_for_ON"-event is accepted.
"pattern_for_ON" and "pattern_for_OFF" must be formed using the following structure:
`device:[regexp]`
The forming-rules are the same as for the notify-command.
Example:
`define BurnerCounter HourCounter SHUTTER_TEST:on SHUTTER_TEST:off`
Set-Commands
`set <name> calc`
starts the calculation of pulse/pause-time.
`set <name> clear`
clears the readings countsPerDay, countsOverall,pauseTimeIncrement, pauseTimePerDay, pauseTimeOverall, pulseTimeIncrement, pulseTimePerDay, pulseTimeOverall by setting to 0.
The reading clearDate is set to the current Date/Time.
`set <name> countsOverall <value>`
Sets the reading countsOverall to the given value.This is the total-counter.
`set <name> countsPerDay <value>`
Sets the reading countsPerDay to the given value. This reading will automatically be set to 0, after change of day.
`set <name> pauseTimeIncrement <value>`
Sets the reading pauseTimeIncrement to the given value.
This reading in seconds is automatically set after a rising edge.
`set <name> pauseTimeEdge <value>`
Sets the reading pauseTimeEdge to the given value.
This reading in seconds is automatically set after a rising edge.
`set <name> pauseTimeOverall <value>`
Sets the reading pauseTimeOverall to the given value.
This reading in seconds is automatically adjusted after a change of pauseTimeIncrement.
`set <name> pauseTimePerDay <value>`
Sets the reading pauseTimePerDay to the given value.
This reading in seconds is automatically adjusted after a change of pauseTimeIncrement and set to 0 after change of day.
`set <name> pulseTimeIncrement <value>`
Sets the reading pulseTimeIncrement to the given value.
This reading in seconds is automatically set after a falling edge of the property.
`set <name> pulseTimeEdge <value>`
Sets the reading pulseTimeEdge to the given value.
This reading in seconds is automatically set after a rising edge.
`set <name> pulseTimeOverall <value>`
Sets the reading pulseTimeOverall to the given value.
This reading in seconds is automatically adjusted after a change of pulseTimeIncrement.
`set <name> pulseTimePerDay <value>`
Sets the reading pulseTimePerDay to the given value.
This reading in seconds is automatically adjusted after a change of pulseTimeIncrement and set to 0 after change of day.
`set <name> forceHourChange`
This modifies the reading tickHour, which is automatically modified after change of hour.
`set <name> forceDayChange`
This modifies the reading tickDay, which is automatically modified after change of day.
`set <name> forceWeekChange`
This modifies the reading tickWeek, which is automatically modified after change of week.
`set <name> forceMonthChange`
This modifies the reading tickMonth, which is automatically modified after change of month.
`set <name> forceYearChange`
This modifies the reading tickYear, which is automatically modified after change of year.
`set <name> app.* <value>`
Any reading with the leading term "app", can be modified.
This can be useful for user-readings.
Get-Commands
`get <name> version`
Get the current version of the module.
Attributes

- interval
  the update interval for pulse/pause-time in minutes [default 60]

- readingFnAttributes

Additional information

- Discussion in FHEM forum

- WIKI information in FHEM Wiki

- The file 99_UtilsHourCounter.pm is a reference implementation for user defined extensions.
  It shows how to create sum values for hours,days, weeks, months and years.
  This file is located in the sub-folder contrib. For further information take a look to FHEM Wiki.

### Hyperion

With Hyperion it is possible to change the color or start an effect on a hyperion server.
It's also possible to control the complete color calibration (changes are temorary and will not be written to the config file).
The Hyperion server must have enabled the JSON server.
You can also restart Hyperion with different configuration files (p.e. switch input/grabber)

Define

`define <name> Hyperion <IP or HOSTNAME> <PORT> [<INTERVAL>]`

<INTERVAL> is optional for periodically polling.
After defining "get <name> statusRequest" will be called once automatically to get the list of available effects and the current state of the Hyperion server.
Example for running Hyperion on local system:

`define Ambilight Hyperion localhost 19444 10`

Example for running Hyperion on remote system:

`define Ambilight Hyperion 192.168.1.4 19444 10`

set <required> [optional]

- addEffect <custom_name>
  add the current effect with the given name to the custom effects
  can be altered after adding in attribute hyperionCustomEffects
  device has to be in effect mode with a non-custom effect and given name must be a unique effect name
- adjustBlue <0,0,255>
  adjust each color of blue separately (comma separated) (R,G,B)
  values from 0 to 255 in steps of 1
- adjustGreen <0,255,0>
  adjust each color of green separately (comma separated) (R,G,B)
  values from 0 to 255 in steps of 1
- adjustRed <255,0,0>
  adjust each color of red separately (comma separated) (R,G,B)
  values from 0 to 255 in steps of 1
- blacklevel <0.00,0.00,0.00>
  adjust blacklevel of each color separately (comma separated) (R,G,B)
  values from 0.00 to 1.00 in steps of 0.01
- clear <1000>
  clear a specific priority channel
- clearall
  clear all priority channels / switch to Ambilight mode
- colorTemperature <255,255,255>
  adjust temperature of each color separately (comma separated) (R,G,B)
  values from 0 to 255 in steps of 1
- configFile <filename>
  restart the Hyperion server with the given configuration file (files will be listed automatically from the given directory in attribute hyperionConfigDir)
  please omit the double extension of the file name (.config.json)
  only available after successful "get <name> configFiles"
- correction <255,255,255>
  adjust correction of each color separately (comma separated) (R,G,B)
  values from 0 to 255 in steps of 1
- dim <percent> [duration] [priority]
  dim the rgb light to given percentage with optional duration in seconds and optional priority
- dimDown [delta]
  dim down rgb light by steps defined in attribute hyperionDimStep or by given value (default: 10)
- dimUp [delta]
  dim up rgb light by steps defined in attribute hyperionDimStep or by given value (default: 10)
- effect <effect> [duration] [priority] [effectargs]
  set effect (replace blanks with underscore) with optional duration in seconds and priority
  effectargs can also be set as very last argument - must be a JSON string without any whitespace
- gamma <1.90,1.90,1.90>
  adjust gamma of each color separately (comma separated) (R,G,B)
  values from 0.00 to 5.00 in steps of 0.01
- luminanceGain <1.00>
  adjust luminanceGain
  values from 0.00 to 5.00 in steps of 0.01
- luminanceMinimum <0.00>
  adjust luminanceMinimum
  values from 0.00 to 5.00 in steps of 0.01
- mode <clearall|effect|off|rgb>
  set the light in the specific mode with its previous value
- off
  set the light off while the color is black
- on
  set the light on and restore previous state
- rgb <RRGGBB> [duration] [priority]
  set color in RGB hex format with optional duration in seconds and priority
- saturationGain <1.10>
  adjust saturationGain
  values from 0.00 to 5.00 in steps of 0.01
- saturationLGain <1.00>
  adjust saturationLGain
  values from 0.00 to 5.00 in steps of 0.01
- threshold <0.16,0.16,0.16>
  adjust threshold of each color separately (comma separated) (R,G,B)
  values from 0.00 to 1.00 in steps of 0.01
- toggle
  toggles the light between on and off
- toggleMode
  toggles through all modes
- valueGain <1.70>
  adjust valueGain
  values from 0.00 to 5.00 in steps of 0.01
- whitelevel <0.70,0.80,0.90>
  adjust whitelevel of each color separately (comma separated) (R,G,B)
  values from 0.00 to 1.00 in steps of 0.01

Get

- configFiles
  get the available config files in directory from attribute hyperionConfigDir
  Will only work properly if at least two config files are found. File names must have no spaces and must end with .config.json .
- devStateIcon
  get the current devStateIcon
- statusRequest
  get the state of the Hyperion server,
  get also the internals of Hyperion including available effects

Attributes

- disable
  stop polling and disconnect
  default: 0
- hyperionBin
  path to the hyperion daemon
  OpenELEC users may set hyperiond.sh as daemon
  default: /usr/bin/hyperiond
- hyperionConfigDir
  path to the hyperion configuration files
  default: /etc/hyperion/
- hyperionCustomEffects
  space separated list of JSON strings (without spaces - please replace spaces in effect names with underlines)
  must include name (as diplay name), oname (name of the base effect) and args (the different effect args), only this order is allowed (if different an error will be thrown on attribute save and the attribut value will not be saved).
  example: {"name":"Knight_Rider_speed_2","oname":"Knight_rider","args":{"color":[255,0,255],"speed":2}} {"name":"Knight_Rider_speed_4","oname":"Knight_rider","args":{"color":[0,0,255],"speed":4}}
- hyperionDefaultDuration
  default duration
  default: 0 = infinity
- hyperionDefaultPriority
  default priority
  default: 0 = highest priority
- hyperionDimStep
  dim step for dimDown/dimUp
  default: 10 (percent)
- hyperionGainStep
  valueGain step for valueGainDown/valueGainUp
  default: 0.1
- hyperionNoSudo
  disable sudo for non-root ssh user
  default: 0
- hyperionSshUser
  user name for executing SSH commands
  default: pi
- hyperionToggleModes
  modes and order of toggleMode as comma separated list (min. 2 modes, max. 4 modes, each mode only once)
  default: clearall,rgb,effect,off
- hyperionVersionCheck
  disable hyperion version check to (maybe) support prior versions
  DO THIS AT YOUR OWN RISK! FHEM MAY CRASH UNEXPECTEDLY!
  default: 1
- queryAfterSet
  If set to 0 the state of the Hyperion server will not be queried after setting, instead the state will be queried on next interval query.
  This is only used if periodically polling is enabled, without this polling the state will be queried automatically after set.
  default: 1

Readings

- adjustBlue
  each color of blue separately (comma separated) (R,G,B)
- adjustGreen
  each color of green separately (comma separated) (R,G,B)
- adjustRed
  each color of red separately (comma separated) (R,G,B)
- blacklevel
  blacklevel of each color separately (comma separated) (R,G,B)
- colorTemperature
  temperature of each color separately (comma separated) (R,G,B)
- configFile
  active/previously loaded configuration file, double extension (.config.json) will be omitted
- correction
  correction of each color separately (comma separated) (R,G,B)
- dim
  active/previous dim value (rgb light)
- duration
  active/previous/remaining primary duration in seconds or infinite
- effect
  active/previous effect
- effectArgs
  active/previous effect arguments as JSON
- gamma
  gamma for each color separately (comma separated) (R,G,B)
- id
  id of the Hyperion server
- lastError
  last occured error while communicating with the Hyperion server
- luminanceGain
  current luminanceGain
- luminanceMinimum
  current luminanceMinimum
- mode
  current mode
- mode_before_off
  previous mode before off
- priority
  active/previous priority
- rgb
  active/previous rgb
- saturationGain
  active saturationGain
- saturationLGain
  active saturationLGain
- serverResponse
  last Hyperion server response (success/ERROR)
- state
  current state
- threshold
  threshold of each color separately (comma separated) (R,G,B)
- valueGain
  valueGain - gain of the Ambilight
- whitelevel
  whitelevel of each color separately (comma separated) (R,G,B)

### I2C_BH1750

Module for the I2C BH1750 light sensor. The BH1750 sensor supports a luminous flux from 0 up to 120k lx and a resolution up to 0.11lx. It supports different modes to be able to cover this large range of data.
The I2C_BH1750 module tries always to get the luminosity data from the sensor as good as possible. To achieve this the module first reads flux data in the least sensitive mode and then decides which mode to take to get best results.
For the I2C bus the same things are valid as described in the I2C_TSL2561 module.
Define

`define BH1750 I2C_BH1750 [I2C address]`
I2C address must be 0x23 or 0x5C (if omitted default address 0x23 is used)
Examples:

            # define IO-Module:
            define I2C_2 RPII2C 2
            # Use IODev I2C_2 with default i2c address 0x23
            # set poll interval to 1 min
            # generate luminosity value only if difference to last value is at least 10%
            define BH1750 I2C_BH1750
            attr BH1750 IODev I2C_2
            attr BH1750 poll_interval 1
            attr BH1750 percentdelta 10

Set

- `set <device name> update`
  Force immediate illumination measurement and restart a new poll_interval. Note that the new readings are not yet available after set returns because the measurement is performed asynchronously. Depending on the flux value this may require more than one second to complete.
- `set <device name> deleteminmax`
  Delete the minimum maximum readings to start new min/max measurement

Readings

- luminosity
  Illumination measurement in the range of 0 to 121557 lx.
  The generated luminosity value is stored with up to one fractional digit for values below 100 and rounded to 3 significant digits for all other values. Compared with the accuracy of the sensor it makes no sense to store the values with more precision.
- minimum
  minimum of measured luminosity
- maximum
  maximum of measured luminosity
- state
  Default: Defined, Ok, Saturated, I2C Error

Attributes

- IODev
  Set the name of an IODev module like RPII2C
  Default: undefined
- poll_interval
  Set the polling interval in minutes to query the sensor for new measured values. By changing this attribute a new illumination measurement will be triggered.
  valid values: 0.1, 0.2, 0.5, 1, 2, 5, 10, 20, 30, 60
- percentdelta
  If set a luminosity reading is only generated if the difference between the current luminosity value and the last reading is at least percentdelta percents.
- correction
  Linear correction factor to be applied to the sensor value. Compared with a commercial light meter it seems that the values for my BH1750 are about 25% to low in day light (correction 1.25). The TLS2561 compares much better with the light meter but has the disadvantage that it saturates at about 40k lux.
  The correction factor can also be used if your sensor is behind an opal glass.
  valid range: 0.5 to 2.0

### I2C_BME280

(en | de)

Provides an interface to the digital pressure/humidity sensor BME280 The I2C messages are send through an I2C interface module like RPII2C, FRM or NetzerI2C so this device must be defined first.
attribute IODev must be set
Define

`define BME280 I2C_BME280 [<I2C Address>]`
without defined `<I2C Address>` 0x76 will be used as address
Examples:

          define BME280 I2C_BME280 0x77
          attr BME280 poll_interval 5

Set

`set BME280 <readValues>`
Reads current temperature, humidity and pressure values from the sensor.
Normaly this execute automaticly at each poll intervall. You can execute this manually if you want query the current values.

Attributes

- oversampling_t,oversampling_h,oversampling_p
  Controls the oversampling settings of the temperature,humidity or pressure measurement in the sensor.
  Default: 1, valid values: 0, 1, 2, 3, 4, 5
  0 switches the respective measurement off
  1 to 5 complies to oversampling value 2^value/2
- poll_interval
  Set the polling interval in minutes to query the sensor for new measured values.
  Default: 5, valid values: any whole number
- roundTemperatureDecimal,roundHumidityDecimal,roundPressureDecimal
  Round temperature, humidity or pressure values to given decimal places.
  Default: 1, valid values: 0, 1, 2
- altitude
  if set, this altitude is used for calculating the pressure related to sea level (nautic null) NN
  Note: this is a global attributes, e.g
  `attr global altitude 220`
- IODev
- do_not_notify
- showtime

### I2C_BMP180

With this module you can read values from the digital pressure sensors BMP180 and BMP085 via the i2c bus on Raspberry Pi.
There are two possibilities connecting to I2C bus:

- via RPII2C module
  The I2C messages are send through an I2C interface module like RPII2C, FRM or NetzerI2C so this device must be defined first.
  attribute IODev must be set
- via HiPi library
  Add these two lines to your /etc/modules file to load the I2C relevant kernel modules automaticly during booting your Raspberry Pi.
  `

      i2c-bcm2708
              i2c-dev

  ` Install HiPi perl modules:
  `

      wget http://raspberry.znix.com/hipifiles/hipi-install
              perl hipi-install

  ` To change the permissions of the I2C device create file:
  `

      	/etc/udev/rules.d/98_i2c.rules

  ` with this content:
  `

      SUBSYSTEM=="i2c-dev", MODE="0666"

  ` Reboot
  To use the sensor on the second I2C bus at P5 connector (only for version 2 of Raspberry Pi) you must add the bold line of following code to your FHEM start script: `

      	case "$1" in
              'start')
              sudo hipi-i2c e 0 1
              ...

  `

Define

`define BMP180 I2C_BMP180 [<I2C device>]`
<I2C device> must not be used if you connect via RPII2C module. For HiPi it's mandatory.
Examples:

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

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

Set

`set BMP180 <readValues>`
Reads the current temperature and pressure values from sensor.
Normaly this execute automaticly at each poll intervall. You can execute this manually if you want query the current values.

Get

N/A

Attributes

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

Notes

- I2C bus timing
  For all sensor operations an I2C interface with blocking IO is assumed (e.g. RPII2C). If you use an I2C interface with non-blocking IO (e.g. FRM over ethernet) operation errors may occur, especially if setting the attribute oversampling_settings to a value higher than 1. This may be compensated depending on I2C interface used. For Firmata try setting the attribute i2c-config in the FRM module to a value of about 30000 microseconds.

### I2C_DS1307

reads a DS1307 real-time clock chip via I2C. Requires a defined I2C-device to work.
Define

`define <name> I2C_DS1307 <i2c-address>`
Specifies the I2C_DS1307 device.
- i2c-address is the (device-specific) address of the ic on the i2c-bus

Set

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

Get

N/A

Attributes

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

### I2C_EEPROM

Provides an interface to an I2C EEPROM.
The I2C messages are send through an I2C interface module like RPII2C, FRM or NetzerI2C so this device must be defined first.
attribute IODev must be set
Define

`define <name> I2C_EEPROM <I2C Address>`
where `<I2C Address>` is without direction bit

Set

`set <name> <byte address> <value>`
where `<byte address>` is a number (0..device specific) and `<value>` is a number (0..255)
both numbers can be written in decimal or hexadecimal notation.
Example:

`set eeprom1 0x02 0xAA`
`set eeprom1 2 170`

Get

`get <name>`
refreshes all readings

`get <name> <byte address> [Bit<bitnumber(0..7)>]`
returnes actual reading of stated <byte address> or a single bit of <byte address>
Values are readout from readings, NOT from device!

Attributes

- poll_interval
  Set the polling interval in minutes to query the EEPROM content
  Default: -, valid values: decimal number
- EEPROM_size
  Sets the storage size of the EEPROM
  Default: 128, valid values: 128 (128bit), 2k (2048bit)
- IODev
- ignore
- do_not_notify
- showtime

### I2C_HDC1008

Provides an interface to the I2C_HDC1008 I2C Humidity sensor from Texas Instruments. The I2C messages are send through an I2C interface module like RPII2C, FRM or NetzerI2C so this device must be defined first.
attribute IODev must be set
Define

`define <name> I2C_HDC1008 [<I2C Address>]`
where `<I2C Address>` is an 2 digit hexadecimal value

Set

`set <name> Update`
Reads the current temperature and humidity values from sensor.
`set <name> Reset`
Resets the sensor `set <name> Heater {on|off}`
turns the sensor heater on or off

Attributes

- interval
  Set the polling interval in minutes to query data from sensor
  Default: 5, valid values: 1,2,5,10,20,30
- Resolution_Temperature
  resolution for measurement temperature.
  Standard: 14Bit, valid values: 11Bit, 14Bit
- Resolution_Humidity
  resolution for measurement humidity.
  Standard: 14Bit, valid values: 8Bit, 11Bit, 14Bit
- roundHumidityDecimal
  Number of decimal places for humidity value
  Default: 1, valid values: 0 1 2,...
- roundTemperatureDecimal
  Number of decimal places for temperature value
  Default: 1, valid values: 0,1,2,...
- IODev

### I2C_K30

(en | de)

Provides an interface to the K30 CO2 sensor from SenseAir. This module expects the sensor to be connected via I2C (for a quick summary, see Application Note 142 "K-30/K-33 I2C on Raspberry Pi" from co2meters.com).
On my Raspberry Pi 2, I needed to reduce I2C frequency to 90 kHz, otherwise most read/write cycles failed (add "options i2c_bcm2708 baudrate=90000", e.g. to /etc/modprobe.d/i2c-options.conf). I still see sporadic errors (about 5% of all readings fail), but this seems to be expected - the datasheet warns that the uC on the sensor will only correctly handle I2C when it's not busy doing CO2 measurement. The I2C messages are sent through an I2C interface module like RPII2C, FRM or NetzerI2C so this device must be defined first.
attribute IODev must be set
Define

`define <name> I2C_K30 [<I2C Address>]`
where `<I2C Address>` is the configured I2C address of the sensor (default: 104, i.e. 0x68)

Set

`set <name> readValues`
Reads the current CO2 value from sensor.

Attributes

- poll_interval
  Set the polling interval in minutes to query data from sensor
  Default: 5, valid values: 1,2,5,10,20,30
- IODev
- do_not_notify
- showtime

### I2C_LCD

drives LiquidCrystal Displays (LCD) that are connected to Firmata (via I2C). Supported are Displays that use a PCF8574T as I2C Bridge (as found on eBay when searching for 'LCD' and 'I2C'). Tested is the 1602 type (16 characters, 2 Lines), the 2004 type (and other cheap chinise-made I2C-LCDs for Arduino) ship with the same library, so they should work as well. See http://arduino.cc/en/Tutorial/LiquidCrystal for details about how to hook up the LCD to the arduino. Requires a defined I2C-device to work.
this I2C-device has to be configures for i2c by setting attr 'i2c-config' on the I2C-device
Define

`define <name> I2C_LCD <size-x> <size-y> <i2c-address>`
Specifies the I2C_LCD device.
- size-x is the number of characters per line
- size-y is the numbers of rows.
- i2c-address is the (device-specific) address of the ic on the i2c-bus

Set

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

Get

N/A

Attributes

- backLight <on|off>
- autoClear <on|off>
- autoBreak <on|off>
- restoreOnStartup <on|off>
- restoreOnReconnect <on|off>
- replaceRegex ä=ae,cd+=ef,g=\x{DF}
  specify find=replace regex pattern eg for non-printable characters. \x{DF} will become char 223, which is º on my lcd.
- customChar<0-7>
  up to 8 5x8px custom chars, see http://www.quinapalus.com/hd44780udg.html for a generator, use \x{00} to \x{07} to display
- IODev
  Specify which I2C to use. (Optional, only required if there is more than one I2C-device defined.)
- eventMap
- readingFnAttributes

### I2C_MCP23008

(en | de)

Provides an interface to the MCP23008 16 channel port extender IC. On Raspberry Pi the Interrupt Pin's can be connected to an GPIO and RPI_GPIO can be used to get the port values if an interrupt occurs.
The I2C messages are send through an I2C interface module like RPII2C, FRM or NetzerI2C so this device must be defined first.
attribute IODev must be set
Define

`define <name> I2C_MCP23008 <I2C Address>`
where `<I2C Address>` is without direction bit

Set

`set <name> <port[,port[...]]> <value>`
where `<port>` is one of PortA0 to PortA7 and `<value>` is one of:

`off
on
`

Example:

`set mod1 PortA4 on`
`set mod1 PortA4,PortA6 off`
`set mod1 PortA4,A6 on`

Get

`get <name>`
refreshes all readings

Attributes

- poll_interval
  Set the polling interval in minutes to query the GPIO's level
  Default: -, valid values: decimal number
- OutputPorts
  Comma separated list of ports that are used as Output
  Ports not in this list can't be written
  Default: no, valid values: A0-A7
- OnStartup
  Comma separated list of output ports and their desired state after start
  Without this atribut all output ports will set to last state
  Default: -, valid values: <port>=on|off|last where <port> = A0-A7
- Pullup
  Comma separated list of input ports which switch on their internal 100k pullup
  Default: -, valid values: A0-A7
- Interrupt
  Comma separated list of input ports which will trigger the IntA/B pin
  Default: -, valid values: A0-A7
- invert_input
  Comma separated list of input ports which use inverted logic
  Default: -, valid values: A0-A7
- InterruptOut
  Configuration options for INT output pin
  Values:
  - active-low (INT output is active low)
  - active-high (INT output is active high)
  - open-drain (INTA output is open drain)
- IODev
- ignore
- do_not_notify
- showtime

### I2C_MCP23017

(en | de)

Provides an interface to the MCP23017 16 channel port extender IC. On Raspberry Pi the Interrupt Pin's can be connected to an GPIO and RPI_GPIO can be used to get the port values if an interrupt occurs.
The I2C messages are send through an I2C interface module like RPII2C, FRM or NetzerI2C so this device must be defined first.
attribute IODev must be set
Define

`define <name> I2C_MCP23017 <I2C Address>`
where `<I2C Address>` is without direction bit

Set

`set <name> <port[,port[...]]> <value>`
where `<port>` is one of PortA0 to PortA7 / PortB0 to PortB7 and `<value>` is one of:

`off
on
`

Example:

`set mod1 PortA4 on`
`set mod1 PortA4,PortB6 off`
`set mod1 PortA4,B6 on`

Get

`get <name>`
refreshes all readings

Attributes

- poll_interval
  Set the polling interval in minutes to query the GPIO's level
  Default: -, valid values: decimal number
- OutputPorts
  Comma separated list of ports that are used as Output
  Ports not in this list can't be written
  Default: no, valid values: A0-A7, B0-B7
- OnStartup
  Comma separated list of output ports and their desired state after start
  Without this atribut all output ports will set to last state
  Default: -, valid values: <port>=on|off|last where <port> = A0-A7, B0-B7
- Pullup
  Comma separated list of input ports which switch on their internal 100k pullup
  Default: -, valid values: A0-A7, B0-B7
- Interrupt
  Comma separated list of input ports which will trigger the IntA/B pin
  Default: -, valid values: A0-A7, B0-B7
- invert_input
  Comma separated list of input ports which use inverted logic
  Default: -, valid values: A0-A7, B0-B7
- InterruptOut
  Configuration options for INTA/INTB output pins
  Values:
  - separate_active-low (INTA/INTB outputs are separate for both ports and active low)
  - separate_active-high (INTA/INTB outputs are separate for both ports and active high)
  - separate_open-drain (INTA/INTB outputs are separate for both ports and open drain)
  - connected_active-low (INTA/INTB outputs are internally connected and active low)
  - connected_active-high (INTA/INTB outputs are internally connected and active high)
  - connected_open-drain (INTA/INTB outputs are internally connected and open drain)
- IODev
- ignore
- do_not_notify
- showtime

### I2C_MCP342x

(en | de)

Provides an interface to the MCP3422/3/4 A/D converter. The I2C messages are send through an I2C interface module like RPII2C, FRM or NetzerI2C so this device must be defined first.
attribute IODev must be set
Define

`define <name> I2C_MCP342x [[<I2C Address>] <n channels>]`
where <I2C Address> is without direction bit and <n channels> is the number of A/D channels

Get

`get <name> [[[<channel>] <resolution> ] <gain>]`
Returns the level on specific <channel>. <resolution> and <gain> will override attibutes for actual operation. Without attributes only the readings will be refreshed.

Attributes

- poll_interval
  Set the polling interval in minutes to query data from sensor
  Default: 5, valid values: 1,2,5,10,20,30
Following attributes are separate for all channels.
- ch1resolution
  resolution settings
  the bigger the resolution the longer the conversion time.
  Default: 12, valid values: 12,14,16,18
- ch1gain
  gain setting
  Important: the gain setting will reduce the measurement range an may produce an overflow. In this case "overflow" will be added to reading
  Default: 1, valid values: 1,2,4,8
- ch1factor
  correction factor (will be mutiplied to channel value)
  Default: 1, valid values: number
- ch1roundDecimal
  Number of decimal places for value
  Default: 3, valid values: 0,1,2,3
- IODev
- do_not_notify
- showtime

### I2C_MMA845X

This modules is a driver for using the Freescale/NXP MMA8451/MMA84512/MMA84513 accelerometer with I2C bus interface (see the NXP product description for full specifications). Note that the Freescale/NXP MMA8450 accelerometer, though similar, has a different register set and cannot be addressed by this module.
The I2C messages are sent through an interface module like RPII2C or FRM, so this device must be defined first and assigned as IODev attribute.
This module supports the following features:

- read current acceleration (x, y, z)
- calibrate acceleration offsets
- orientation detection
- motion detection (at least one axis above threshold) or freefall detection (all axes below threshold)
- jolt detection (at least one axis change above threshold)
- single and/or double pulse (tap) detection
- detection event latching
- hardware interrupt signalling of detection events

The accelerometer is configured for an output data rate of 200 Hz in normal oversampling mode with the low noise filter enabled providing a full scale range of +/-4 g as default. This output data rate can be changed if required.
The detection events (orientation, motion/freefall, jolt, pulse) can be signaled by one or two hardware outputs that can be used for interrupt driven operations without need for continuous polling. If the event latch is enabled, the events and the interrupt signals will remain set until the event source register is read, providing additional event details (e.g. axis, direction). With orientation detection the event latch is always enabled.
The acceleration measurement output can optionally be passed through a high-pass filter with a selectable cutoff frequency effectively eliminating the gravity offset of 1g to provide change detection instead of orientation detection. The motion/freefall detection will always bypass the high-pass filter while the jolt and pulse detections will always use the high-pass filter with default settings. When using motion detection you would typically not enable the gravity axis or set a threshold higher than 1 g.
While the orientation detection works well with the default settings the other detection modes typically require fine tuning of their parameters. To understand the detection modes and their parameters in detail please refer to the Freescale annotations AN4068 (orientation), AN4070 (freefall/motion), AN4071 (jolt) and AN4072 (pulse).
Several of the parameters represent a frequency [Hz], a threshold [g]/[°] or a duration [ms]. Their absolute values often depend on a combination of register settings requiring lookup tables. This module uses the raw binary values for these attributes making fine tuning easier because value granularity is always 1. If you need to translate between binary values and absolute values please refer to the device documentation.
Define

`define <device name> I2C_MMA845X <I2C address>`
`<I2C address>` may be 0x1C or 0x1D
Example:

                 define MMA8452 I2C_MMA845X 0x1D
                 attr MMA8452 IODev I2CModule
                 attr MMA8452 pollInterval 5

Notes:

- The I2C bus connection must be kept active between write and read with the MMA8451/MMA84512/MMA84513 devices (repeated start alias combined write/read). This communication mode is not the default on most platforms:
  Raspberry:
  - Change parameter 'combined' of BCM2708 driver from N to Y.
    Temporary: `sudo su - echo -n 1 > /sys/module/i2c_bcm2708/parameters/combined exit`.
    Permanent: add `echo -n 1 > /sys/module/i2c_bcm2708/parameters/combined` to script `/etc/init.d/rc.local`.
  - Set attribute `useHWLib` of your RPII2C device to `SMBus` (RPII2C's ioctl mode currently does not support combined write/read mode).
  Firmata:
  - Make sure to call `Wire.endTransmission(false)`. Currently requires manually changing the `ino` file (Standard Firmata) or `I2CFirmata.h` (Configurable Firmata).

Set

- `set <device name> calibrate`
  Calibrate the acceleration offset based on the next sample assuming 1g gravity on any one axis.
  Prerequisites: Align one axis with gravity and keep device stationary during calibration.

Get

- `get <device name> update`
  Request an update of the acceleration readings.
- `get <device name> orientation`
  Request an update of the orientation reading.
- `get <device name> eventSources`
  Request an update of the event source readings.
- `get <device name> update`
  Perform manual polling, e.g. when attribute `pollInterval` is set to zero. At least one of `pollAccelerations`, `pollOrientation` or `pollEventSources` should be enabled.

Attributes

`attr <device name> <attribute name> <value>`
Attributes:

- IODev <IODev device name>
  I2C IODev device name, no default, required
- pollInterval <seconds>
  period for updating acceleration and event source readings, default 10 s
  fractional seconds are supported, use 0 to disable polling
- pollAccelerations 0|1
  include reading of accelerations when polling, default 1
- pollOrientation 0|1
  include reading of orientation when polling, default 1
- pollEventSources 0|1
  include reading of event sources when polling, default 1
- disable 0|1
  disables device (I2C operations), default 0
- outputDataRate <frequency>
  device internal acceleration value output rate, may be one of 1.56, 6.25, 12.5, 50, 100, 200, 400 or 800 Hz, default 200 Hz
  affects all timing parameters, is independent of pollInterval
- highPass <function>[,<function>]
  select which function should use the high-pass filter, may be any of outputData, jolt or pulse, default jolt,pulse
  activating the high-pass filter will remove the 1g offset in the gravity direction
- highPassCutoffFrequency 0 ... 3
  set the high-pass filter cutoff frequency, changes with on output data rate, default 0
  0 is a higher cutoff frequency (up to 16 Hz) and 3 is a lower cutoff frequency (down to 0.25 Hz), see device manual for details
- orientation...
  orientation detection parameters, see device manual for details
- motion...
  motion/freefall detection parameters, see device manual for details
- jolt...
  jolt detection parameters, see device manual for details
- pulse...
  pulse (tap) detection parameters, see device manual for details
- ...EventLatch 0|1
  if enabled an event (and the hardware output) will stay latched until the event source register is read, default 0
  the corresponding event source reading will provide additional information about the event
- ...Interrupt 0|1|2
  an event will also raise one of two hardware outputs, default 0
  use 0 to disable linking an event with an hardware outputs

Readings

- out...
  acceleration for x, y and z axes [g]
  the number of decimal places is limited to 3 to remove a significant amount of noise
- off...
  acceleration offset for x, y and z axes from last calibration [g]
  to adjust offsets manually at runtime, change offset readings and toggle disable attribute
- orientation
  current orientation, orientation detection must be enabled, the reading is only updated on change
  P=portrait + U=up/D=down or L=landscape + L=left/R=right, B=back or F=front, X=z-lockout
- ...Event
  source of last event, event and event latch must be enabled, the reading is only updated on change
  motion/jolt/pulse: X, Y or Z for the affected axis preceded by a sign for the direction of the the event
  pulse: additional pulse type indicator postfix S=single or D=double

### I2C_PCA9532

(en | de)

Provides an interface to the PCA9532 I2C 16 channel PWM IC. The PCA9532 has 2 independent PWM stages and every channel can be attached to on of these stages or directly turned on or off. The I2C messages are send through an I2C interface module like RPII2C, FRM or NetzerI2C so this device must be defined first.
attribute IODev must be set
Define

`define <name> I2C_PCA9532 <I2C Address>`
where `<I2C Address>` is an 2 digit hexadecimal value

Set

`set <name> <port> <value>`

- if `<port>` is one of Port0 to Port15, then `<value>` will be one of:
  `off
  on
  PWM0 (output is switched with PWM0 frequency and duty cycle)
  PWM1 (output is switched with PWM1 frequency and duty cycle)
  `
- if `<port>` is PWM0 or PWM1, then `<value>` is an value between 0 and 255 and stands for the duty cycle of the PWM stage.

Examples:

`set mod1 Port4 PWM1`
`set mod1 PWM1 128`

Get

`get <name>`
refreshes all readings

Attributes

- poll_interval
  Set the polling interval in minutes to query the GPIO's level
  Default: -, valid values: decimal number
- OutputPorts
  Comma separated list of Portnumers that are used as Outputs
  Only ports in this list can be written
  Default: no, valid values: 0 1 2 .. 15
- OnStartup
  Comma separated list of output ports/PWM registers and their desired state after start
  Without this atribut all output ports will set to last state
  Default: -, valid values: <port>=on|off|PWM0|PWM1|last or PWM0|PWM1=0..255|last where <port> = 0 - 15
- T0/T1
  Sets PWM0/PWM1 to another Frequency. The Formula is: Fx = 152/(Tx + 1) The corresponding frequency value is shown under internals.
  Default: 0 (152Hz), valid values: 0-255
- IODev
- ignore
- do_not_notify
- showtime

### I2C_PCA9685

(en | de)

Provides an interface to the PCA9685 I2C 16 channel PWM IC. The I2C messages are send through an I2C interface module like RPII2C, FRM or NetzerI2C so this device must be defined first.
attribute IODev must be set
Define

`define <name> I2C_PCA9685 <I2C Address> [<I2C Buffer Size>]`
where `<I2C Address>` can be written as decimal value or 0xnn
`<I2C Buffer Size>` sets the maximum size of the I2C-Packet. Without this option the packet size is 30 Bytes (32 incl. Address and Register number). For RPII2C this option has no influence, cause it can deal with arbitrary packet sizes.

Set

`set <name> <port> <dimvalue> [<delay>]`
- where `<port>` is one of Port0 to Port15
  and `<dimvalue>` one of
  `off
  on
  0..4095
  `
  `<delay>` defines the switch on time inside the PWM counting loop. It does not have an influence to the duty cycle. Default value is 0 and, possible values are 0..4095
- It is also possible to change more than one port at the same time. Just separate them by comma. If only the last of the comma separated ports has dimvalue (and delay), all ports will set to the same values. Sequently ports will set at once (useful for multi color LED's).
  Also P instead of Port is Possible.
Examples:

`set mod1 Port04 543`
`set mod1 Port4 434 765`
`set mod1 Port1, Port14 434 765`
`set mod1 Port1 on, P14 434 765`

Get

`get <name>`
refreshes all readings

Attributes

- SUBADR1,SUBADR2,SUBADR3,ALLCALLADR
  Alternative slave addresses, if you want to control more than one PCA9685 with one define Respective flag in modereg1 must be set as well
  Default: SUBADR1=113,SUBADR2=114,SUBADR3=116,ALLCALLADR=112, valid values: valid I2C Address
- OnStartup
  Comma separated list of output ports/PWM registers and their desired state after start
  Without this atribut all output ports will set to last state
  Default: -, valid values: <port>=on|off|0..4095|last where <port> = 0 - 15
- prescale
  Sets PWM Frequency. The Formula is: Fx = 25MHz/(4096 * (prescale + 1)). The corresponding frequency value is shown under internals. If provided, attribute extClock will be used for frequency calculation. Otherwise 25MHz
  Default: 30 (200Hz for 25MHz clock), valid values: 0-255
- modereg1
  Comma separated list of:
  - EXTCLK
    If set the an external connected clock will be used instead of the internal 25MHz oscillator. Use the attribute extClock to provide the external oscillater value.
  - SUBADR1
    If set the PCA9685 responds to I2C-bus SUBADR 1.
  - SUBADR2
    If set the PCA9685 responds to I2C-bus SUBADR 2.
  - SUBADR3
    If set the PCA9685 responds to I2C-bus SUBADR 3.
  - ALLCALLADR
    If set the PCA9685 responds to I2C-bus ALLCALLADR address.
- modereg2
  Comma separated list of:
  - INVRT
    If set the Output logic state is inverted.
  - OCH
    If set the outputs changes on ACK (after every byte sent).
    Otherwise the output changes on STOP command (bus write action finished)
  - OUTDRV
    If set the outputs are configured with a totem pole structure.
    Otherwise the outputs are configured with open-drain.
  Behaviour when OE = 1 (if OE = 0 the output will act according OUTDRV configuration):
  - OUTNE0
    If set:
    LEDn = 1 when OUTDRV = 1
    LEDn = high-impedance when OUTDRV = 0
    If not set: LEDn = 0.
  - OUTNE1
    LEDn = high-impedance.
    OUTNE1 overrides OUTNE0
- IODev
- ignore
- do_not_notify
- showtime

### I2C_PCF8574

(en | de)

Provides an interface to the PCA9532 8 channel port extender IC. On Raspberry Pi the Interrupt Pin can be connected to an GPIO and RPI_GPIO can be used to get the port values if an interrupt occurs.
The I2C messages are send through an I2C interface module like RPII2C, FRM or NetzerI2C so this device must be defined first.
attribute IODev must be set
Define

`define <name> I2C_PCF8574 <I2C Address>`
where `<I2C Address>` is without direction bit

Set

`set <name> <port[,port[...]]> <value>`

- `<port>` is one of Port0 to Port7 and `<value>` is one of:
  `off
  on
  `

Example:

`set mod1 Port4 on`
`set mod1 Port4,Port6 off`
`set mod1 Port4,6 on`

Get

`get <name>`
refreshes all readings

Attributes

- poll_interval
  Set the polling interval in minutes to query the GPIO's level
  Default: -, valid values: decimal number
- InputPorts
  Space separated list of Portnumers that are used as Inputs
  Ports in this list can't be written
  Default: no, valid values: 0 1 2 .. 7
- OnStartup
  Comma separated list of output ports and their desired state after start
  Without this atribut all output ports will set to last state
  Default: -, valid values: <port>=on|off|last where <port> = 0 - 7
- IODev
- ignore
- do_not_notify
- showtime

### I2C_SHT21

(en | de)

Provides an interface to the SHT21 I2C Humidity sensor from Sensirion. The I2C messages are send through an I2C interface module like RPII2C, FRM or NetzerI2C so this device must be defined first.
attribute IODev must be set
Define

`define <name> I2C_SHT21 [<I2C Address>]`
where `<I2C Address>` is an 2 digit hexadecimal value

Set

`set <name> readValues`
Reads the current temperature and humidity values from sensor.

Attributes

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

### I2C_SHT3x

(en | de)

Provides an interface to the SHT30/SHT31 I2C Humidity sensor from Sensirion. The I2C messages are sent through an I2C interface module like RPII2C, FRM or NetzerI2C so this device must be defined first.
attribute IODev must be set
Define

`define <name> I2C_SHT3x [<I2C Address>]`
where `<I2C Address>` is an 2 digit hexadecimal value:
ADDR (pin 2) connected to VSS (supply voltage): 0x44 (default, if `<I2C Address>` is not set)
ADDR (pin 2) connected to VDD (ground): 0x45
For compatible sensors also other values than 0x44 or 0x45 can be set.

Set

`set <name> readValues`
Reads the current temperature and humidity values from sensor.

Attributes

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

### I2C_TSL2561

With this module you can read values from the ambient light sensor TSL2561 via the i2c bus on Raspberry Pi.
The luminosity value returned is a good human eye reponse approximation of an illumination measurement in the range of 0.1 to 40000+ lux (but not a replacement for a precision measurement, relation between measured value and true value may vary by 40%).
There are two possibilities connecting to I2C bus:

- via IODev module
  The I2C messages are send through an I2C interface module like RPII2C, FRM or NetzerI2C so this device must be defined first.
  attribute IODev must be set
- via HiPi library
  Add these two lines to your /etc/modules file to load the I2C relevant kernel modules automaticly during booting your Raspberry Pi.
  `

                  i2c-bcm2708
                  i2c-dev

  ` Install HiPi perl modules:
  `

       wget http://raspberry.znix.com/hipifiles/hipi-install perl hipi-install

  ` To change the permissions of the I2C device create file:
  `

       /etc/udev/rules.d/98_i2c.rules

  ` with this content:
  `

       SUBSYSTEM=="i2c-dev", MODE="0666"

  ` Reboot
  To use the sensor on the second I2C bus at P5 connector (only for version 2 of Raspberry Pi) you must add the bold line of following code to your FHEM start script: `

                  case "$1" in
                  'start')
                      sudo hipi-i2c e 0 1
                  ...

  `

Define

`define TSL2561 I2C_TSL2561 [<I2C device>] <I2C address>`
<I2C device> mandatory for HiPi, must be omitted if you connect via IODev
<I2C address> may be 0x29, 0x39 or 0x49 (and 'AUTO' when using IODev to search for device at startup and after an I2C error)
Examples:

            define TSL2561 I2C_TSL2561 /dev/i2c-0 0x39
            attr TSL2561 poll_interval 5

            define TSL2561 I2C_TSL2561 0x39
            attr TSL2561 IODev I2CModule
            attr TSL2561 poll_interval 5

            define TSL2561 I2C_TSL2561 AUTO
            attr TSL2561 IODev I2CModule
            attr TSL2561 poll_interval 5

Set

`get <name> update`
Force immediate illumination measurement and restart a new poll_interval.
Note that the new readings are not yet available after set returns because the measurement is performed asynchronously. Depending on the attributes integration time, autoGain and autoIntegrationTime this may require more than one second to complete.

Readings

- luminosity
  Good human eye reponse approximation of an illumination measurement in the range of 0.1 to 40000+ lux.
  Rounded to 3 significant digits or one fractional digit.
- broadband
  Broadband spectrum sensor sample.
  Enable attribute normalizeRawValues for continuous readings independed of actual gain and integration time settings.
- ir
  Infrared spectrum sensor sample.
  Enable attribute normalizeRawValues for continuous readings independed of actual gain and integration time settings.
- gain
  sensor gain used for current luminosity measurement (1 or 16)
- integrationTime
  integration time in seconds used for current luminosity measurement
- state
  Default: Initialized, valid values: Undefined, Defined, Initialized, Saturated, Disabled, I2C Error

Attributes

- IODev
  Set the name of an IODev module. If undefined the perl modules HiPi::Device::I2C are required.
  Default: undefined
- poll_interval
  Set the polling interval in minutes to query the sensor for new measured values. By changing this attribute a new illumination measurement will be triggered.
  Default: 5, valid values: 1, 2, 5, 10, 20, 30
- gain
  Set gain factor. Attribute will be ignored if autoGain is enabled.
  Default: 1, valid values: 1, 16
- integrationTime
  Set time in ms the sensor takes to measure the light. Attribute will be ignored if autoIntegrationTime is enabled.
  Default: 13, valid values: 13, 101, 402
  See this tutorial for more details.
- autoGain
  Enable auto gain. If set to 1, the gain parameter is adjusted automatically depending on light conditions.
  Default: 1, valid values: 0, 1
- autoIntegrationTime
  Enable auto integration time. If set to 1, the integration time parameter is adjusted automatically depending on light conditions.
  Default: 0, valid values: 0, 1
- normalizeRawValues
  Scale the sensor raw values broadband and ir depending on actual gain and integrationTime to the equivalent of the settings for maximum sensitivity (gain=16 and integrationTime=403ms). This feature may be useful when autoGain or autoIntegrationTime is enabled to provide continuous values instead of jumping values when gain or integration time changes.
  Default: 0, valid values: 0, 1
- floatArithmetics
  Enable float arithmetics.
  If set to 0, the luminosity is calculated using int arithmetics (for very low powered platforms).
  If set to 1, the luminosity is calculated using float arithmetics, yielding some additional precision. Default: 1, valid values: 0, 1
- disable
  Disable I2C bus access.
  Default: 0, valid values: 0, 1

Notes

- Because the measurement may take several 100 milliseconds a measurement cycle will be executed asynchronously, so do not expect to have new values immediately available after "set update" returns. If autoGain or autoIntegrationTime are enabled, more than one measurement cycle will be required if light conditions change.
- With HiPi and especially IODev there are several I2C interfaces available, some blocking, some non-blocking and some with different physical layers. The module has no knowledge of the specific properties of an interface and therefore module operation and timing may not be exactly the same with each interface type.
- If AUTO is used as device address, one address per measurement cycle will be tested. Depending on your device address it may be necessary to execute "set update" several times to find your device.
- When using Firmata the I2C write/read delay attribute "i2c-config" of the FRM module can be set to any value.

### IF

`IF (<condition>) (<FHEM commands1>) ELSE (<FHEM commands2>)`
Executes <FHEM commands1> if <condition> is true, else <FHEM commands2> are executed.
IF can be used anywhere where FHEM commands can be used.
The ELSE-case is optional.
The <condition> is the same as in perl-if.
In addition, readings can be specified in the form:
[<device>:<reading>:<format>|[<regular expression>]]
In addition, internals can be specified with & in the form:
[<device>:&<internal>:<format>|[<regular expression>]]
<format> and [<regular expression>] are filter options und are optional.
possible <format>:
'd' for decimal number
If only the state of a device is to be used, then only the device can be specified:
`[<device>]` corresponsed to `[<device>:&STATE]`
Examples:
IF in combination with at-module, Reading specified in the condition:
`define check at +00:10 IF ([outdoor:humidity] > 70) (set switch1 off) ELSE (set switch1 on)
`
IF state query of the device "outdoor" in the condition:
`define check at +00:10 IF ([outdoor] eq "open") (set switch1 on)
`
corresponds with details of the internal:
`define check at +00:10 IF ([outdoor:&STATE] eq "open") (set switch1 on)
`
If the reading "state" to be queried, then the name of reading is specified without &:
`define check at +00:10 IF ([outdoor:state] eq "open") (set switch1 on)
`
Nested IF commands (It can be entered in the DEF input on multiple lines with indentation for better representation):
`define test notify lamp
IF ([lampe] eq "on") (

IF ([outdoor:humidity] < 70)

(set lamp off)

ELSE

(set lamp on)

) ELSE

(set switch on)

` Filter by numbers in Reading "temperature":
`define settemp at 22:00 IF ([tempsens:temperature:d] >= 10) (set heating on)
`
Filter by "on" and "off" in the status of the device "move":
`define activity notify move IF ([move:&STATE:[(on|off)]] eq "on" and $we) (set lamp off)
`
Example of the use of Readings in the then-case:
`define temp at 18:00 IF ([outdoor:temperature] > 10) (set lampe [dummy])
`
If an expression is to be evaluated first in a FHEM command, then it must be enclosed in brackets.
For example, if at 18:00 clock the outside temperature is higher than 10 degrees, the desired temperature is increased by 1 degree:
`define temp at 18:00 IF ([outdoor:temperature] > 10) (set thermostat desired-temp {([thermostat:desired-temp:d]+1)})
`
Multiple commands are separated by a comma instead of a semicolon, thus eliminating the doubling, quadrupling, etc. of the semicolon:
`define check at +00:10 IF ([outdoor:humidity] > 10) (set switch1 off,set switch2 on) ELSE (set switch1 on,set switch2 off)
`
If a comma in FHEM expression occurs, this must be additionally bracketed so that the comma is not recognized as a delimiter:
`define check at +00:10 IF ([outdoor:humidity] > 10) ((set switch1,switch2 off))
`
IF in combination with a define at multiple set commands:
`define check at *10:00 IF ([indoor] eq "on") (define a_test at +00:10 set lampe1 on;;set lampe2 off;;set temp desired 20)
`
The comma can be combined as a separator between the FHEM commands with double semicolon, eg:
`define check at *10:00 IF ([indoor] eq "on") (set lamp1 on,define a_test at +00:10 set lampe2 on;;set lampe3 off;;set temp desired 20)
`
sleep can be used with comma, it is not blocking:
`define check at *10:00 IF ([indoor] eq "on") (sleep 2,set lampe1 on,sleep 3,set lampe2 on)`
Time-dependent switch: In the period 20:00 to 22:00 clock the light should go off when it was on and I leave the room:
`define n_lamp_off notify sensor IF ($hms gt "20:00" and $hms lt "22:00" and [sensor] eq "absent") (set lamp:FILTER=STATE!=off off)
`
Combination of Perl and FHEM commands ($NAME and $EVENT can also be used):
`define mail notify door:open IF ([alarm] eq "on")({system("wmail $NAME:$EVENT")},set alarm_signal on)
`

### IPCAM

Define

`define <name> IPCAM <ip[:port]>`
Defines a network camera device to trigger snapshots on events.
Network cameras (IP cameras) usually have a build-in function to create snapshot images. This module enables the event- or time-controlled recording of these images.
In addition, this module allows the recording of many image formats like JPEG, PNG, GIF, TIFF, BMP, ICO, PPM, XPM, XBM and SVG. The only requirement is that the recorded image must be accessible via a URL.
So it is also possible to record images of e.g. a public Weather Camera from the internet or any picture of a website.
Furthermore, it is possible to control the camera via PTZ-mode or custom commands.
Examples:
A local ip-cam takes 5 snapshots with 10 seconds delay per call:

`define ipcam IPCAM 192.168.1.205`
`attr ipcam delay 10`
`attr ipcam path snapshot.cgi?user=foo&pwd=bar`
`attr ipcam snapshots 5`
`attr ipcam storage /srv/share/surveillance/snapshots`

A notify on a motion detection of a specified device:

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

Send an eMail after snapshots are taken:

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

A public web-cam takes only 1 snapshot per call:

`define schloss IPCAM www2.braunschweig.de`
`attr schloss path webcam/schloss.jpg`
`attr schloss storage /srv/share/surveillance/snapshots`

An at-Job takes every hour a snapshot:

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

Move the camera up:

`set ipcam tilt up`

Move the camera to a the predefined position 4:

`set ipcam pos 4`

Set

`set <name> <value> <argument>`
where `value` is one of:

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

Get

`get <name> <value>`
where `value` is one of:

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

Attributes

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

            #
            # Webcam credentials
            #
            $credentials{<name_cam1>}{username} = "<your_username>";
            $credentials{<name_cam1>}{password} = "<your_password>";
            $credentials{<name_cam2>}{username} = "<your_username>";
            $credentials{<name_cam2>}{password} = "<your_password>";
            ...

  Replace `<name_cam1>` respectively `<name_cam2>` with the names of your defined ip-cams and `<your_username>` respectively `<your_password>` with your credentials (all without the brackets `<` and `>`!).
- delay
  Defines the time interval between snapshots in seconds.
  If more then one snapshot is taken, then it makes sense to define a short delay between the snapshots. On the one hand, the camera is not addressed in short intervals and the second may be better represented movements between images.
  Example: `attr ipcam3 delay 10`
- disable
- do_not_notify
- loglevel
- readingFnAttributes
- path
  Defines the path and query component of the complete URI to get a snapshot of the camera. Is the full URI of your ip-cam for example `http://CAMERA_IP/snapshot.cgi?user=admin&pwd=password`, then only the path and query part is specified here (without the leading slash (/).
  Example:
  `attr ipcam3 path snapshot.cgi?user=admin&pwd=password`
  If you prefer to store the credentials in a file (take a look at the attribute `credentials`) you have to set the placeholder `{USERNAME}` and `{PASSWORD}` in the path string. These placeholders will be replaced with the values from the credentials file.
  Example:
  `attr ipcam3 path snapshot.cgi?user={USERNAME}&pwd={PASSWORD}`
- pathCmd
  Defines a path for the custom commands, if it is necessary.
  Example:
  `attr ipcam3 pathCmd set_misc.cgi`
- pathPanTilt
  Defines a path for the PTZ-mode commands `pan`, `tilt` and `pos`, if it is necessary.
  Example:
  `attr ipcam3 pathPanTilt decoder_control.cgi?user={USERNAME}&pwd={PASSWORD}`
- showtime
- snapshots
  Defines the total number of snapshots to be taken with the `get <name> image` command. If this attribute is not defined, then the default value is 1.
  The snapshots are stored in the given path of the attribute `storage` and are numbered sequentially (starts with 1) like `snapshot_01`, `snapshot_02`, etc. Furthermore, an additional file `last` will be saved, which is identical with the last snapshot-image. The module checks the imagetype and stores all these files with the devicename and a correct extension, e.g. `<devicename>_snapshot_01.jpg`.
  If you like a timestamp instead a sequentially number, take a look at the attribute `timestamp`.
  All files are overwritten on every `get <name> image` command (except: snapshots with a timestamp. So, keep an eye on your diskspace if you use a timestamp extension!).
  Example:
  `attr ipcam3 snapshots 5`
- storage
  Defines the location for the file storage of the snapshots.
  Default: `$modpath/www/snapshots`
  Example:
  `attr ipcam3 storage /srv/share/surveillance/snapshots`
- timestamp
  If this attribute is unset or set to 0, snapshots are stored with a sequentially number like `<devicename>_snapshot_01.jpg`, `<devicename>_snapshot_02.jpg`, etc.
  If you like filenames with a timestamp postfix, e.g. `<devicename>_20121023_002602.jpg`, set this attribute to 1.

Generated events

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

### IPWE

Define

`define <name> IPWE <hostname> [<delay>]`
Define a IPWE network attached weather data receiver device sold by ELV. Details see here. It's intended to receive the same sensors as WS300 (8 T/H-Sensors and one kombi sensor), but can be accessed via http and telnet.
For unknown reason, my try to use the telnet interface was not working neither with raw sockets nor with Net::Telnet module. Therefore i choosed here the "easy" way to simple readout the http page and extract all data from the offered table. For this reason this module doesnt contain any option to configure this device.
Note: You should give your sensors a name within the web interface, once they a received the first time.
To extract a single sensor simply match for this name or sensor id
Attributes:

- `delay`: seconds between read accesses(default 300s)

Example:

`define ipwe IPWE ipwe1 120`

`attr ipwe delay 600` : 10min between readouts

Set

N/A

Get

`get <name> status`
Gets actual data from device for sensors with data
`get <name> <sensorname>`
will grep output from device for this sensorname

Attributes

- model (ipwe)
- delay
- loglevel

### IT - InterTechno

The InterTechno 433MHZ protocol is used by a wide range of devices, which are either of the sender/sensor or the receiver/actuator category. Right now, we are able to SEND and RECEIVE InterTechno commands. Supported are devices like switches, dimmers, etc. through an CUL or SIGNALduino device, this must be defined first.
This module supports Intertechno protocol version 1 and version 3. Newly found devices are added into the category "IT" by autocreate. Hint: IT protocol 1 devices are created on pressing the on-button.
Define

`define <name> IT <housecode> <on-code> <off-code> [<dimup-code>] [<dimdown-code>]`
or
`define <name> IT <ITRotarySwitches|FLS100RotarySwitches>`
or
`define <name> IT <address 26 Bit> <group bit> <unit Code>`
or
`define <name> IT HE800 <Transmitter ID> <Receiver ID>`
The value of housecode is a 10-digit InterTechno Code, consisting of 0/1/F as it is defined as a tri-state protocol. These digits depend on the device you are using.
Bit 11 and 12 are used for switching/dimming. As different manufacturers are using different bit-codes you can specifiy here the 2-digit code for off/on/dimup/dimdown in the same form: 0/1/F.
The value of ITRotarySwitches consists of the value of the alpha switch A-P and the numeric switch 1-16 as set on the intertechno device. E.g. A1 or G12.
The value of FLS100RotarySwitches consist of the value of the I,II,II,IV switch and the numeric 1,2,3,4 swicht. E.g. I2 or IV4.
The value of ITRotarySwitches and FLS100RotarySwitches are internaly translated into a houscode value.

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

HE800

- `<Transmitter ID>` Eindeutige Transmitter-ID (1..65535)
- `<Receiver ID>` Receiver-ID [0]1..15, 0=Broadcast 1-15 (HE844A button# 1-4 & MASTER=0, HE850 UNIT# 1-15, HE853 = 1)

Examples:

`define lamp IT 01FF010101 11 00 01 10`
`define roll1 IT 111111111F 11 00 01 10`
`define otherlamp IT 000000000F 11 10 00 00`
`define otherroll1 IT FFFFFFF00F 11 10`
`define IT_1527xe0fec IT 1527xe0fec 1001 0000`
`define itswitch1 IT A1`
`define lamp IT J10`
`define flsswitch1 IT IV1`
`define lamp IT II2`
`define HE800_TID1_SW1 IT HE800 1 1`

For Intertechno protocol 3 the <housecode> is a 26-digits number. Additionaly there are a 4-digits unit code and a 1-digit group code used.

- `<address>` is a 26 digit number (0/1)
- `<group>` is a 1 digit number (0/1)
- `<unit>` is a 4 digit number (0/1)

Examples:

`define myITSwitch IT 00111100110101010110011111 0 0000`

Set

`set <name> <value> [<time>]`
where `value` is one of:

        dimdown
        dimup
        off
        on
        on-till           # Special, see the note
        dim06% dim12% dim18% dim25% dim31% dim37% dim43% dim50%
        dim56% dim62% dim68% dim75% dim81% dim87% dim93% dim100%

        set extensions are supported.

Examples:

`set lamp on`
`set lamp1,lamp2,lamp3 on`
`set lamp1-lamp3 on`
`set lamp off`

Notes:

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

Get

N/A

Attributes

- IODev
  Set the IO device which will be used to send signals for this device. An example for the physical device is a CUL. Note: On startup, fhem DOES NOT assign an InterTechno device to an IODevice! The attribute IODev needs to be used ALWAYS!
- 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(,) the values are not separated by space but by this character to enable spaces in values. 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
- readingFnAttributes
- model
  The model attribute denotes the type of the device. This attribute will (currently) not be used by fhem.pl directly. It can be used by e.g. external programs or web interfaces to distinguish classes of devices and send the appropriate commands (e.g. "on" or "off" to a switch, "dim..%" to dimmers etc.). The spelling of the model should match the modelname used in the documentation that comes which the device. The name should consist of lower-case characters without spaces. Valid characters are `a-z 0-9` and `-` (dash), other characters should not be used. Here is a list of "official" devices:
  Sender/Sensor: itremote
  Dimmer: itdimmer
  Receiver/Actor: itswitch
  EV1527: ev1527
- ignore
  Ignore this device, e.g. if it belongs to your neighbour. The device won't trigger any FileLogs/notifys, issued commands will be 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 be affected by commands which use wildcards or attributes as name specifiers (see devspec). You still get them with the "ignored=1" special devspec.

Generated events:

From an IT device you can receive the following events.
- on
- off
- dimdown
- dimup
- dim06% dim12% dim18% dim25% dim31% dim37% dim43% dim50%
  dim56% dim62% dim68% dim75% dim81% dim87% dim93% dim100%
Which event is sent is device dependent and can sometimes configured on the device.

### InfoPanel

InfoPanel is an extension to FHEMWEB. You must install FHEMWEB to use InfoPanel.
Prerequesits

- InfoPanel is an extension to FHEMWEB. You must install FHEMWEB to use InfoPanel.
- Module uses following additional Perl modules:
  `MIME::Base64 Image::Info`
  If not already installed in your environment, please install them using appropriate commands from your environment.
  Package installation in debian environments: `apt-get install libmime-base64-perl libimage-info-perl`
- You can use this module without the two additional perl modules, but in this case, you have to accept some limitations:
  - layout tag img can not be used
  - layout tag plot can only handle scale = 1 and inline = 0

Define

`define <name> InfoPanel <layoutFileName>`
Example:

`define myInfoPanel InfoPanel ./FHEM/panel.layout`

Set-Commands

- `set <name> reread`
  Rereads the layout definition from the file.
  Important:
  Layout will be reread automatically if edited via fhem's "Edit files" function.
  Autoread can be disabled via attribute.
- `set <name> ovEnable <xconditionName>`
  set an override "1" to named xcondition
- `set <name> ovDisable <xconditionName>`
  set an override "0" to named xcondition
- `set <name> ovClear <xconditionName>|all;`
  delete an existing overrides to named xcondition. "all" will clear all overrides.

Get-Commands

- `get <name> counter`
  return value from internal counter
- `get <name> layout`
  return complete layout definition
- `get <name> overrides`
  return list of defined overrides

Attributes

- autoreread - disables automatic layout reread after edit if set to 1
- refresh - time (in seconds) after which the HTML page will be reloaded automatically.
  Any values below 60 seconds will not become valid.
- showTime - disables generation timestamp in state if set to 0
- size - The dimensions of the picture in the format `<width>x<height>`
- useViewPort - add viewport meta tag to fit mobile displays
- mobileApp - add support for mobile fullscreen experience
- title - webpage title to be shown in Browser
- bgcenter - background images will not be centered if attribute set to 0. Default: show centered
- bgcolor - defines the background color, use html-hexcodes to specify color, eg 00FF00 for green background. Default color is black. You can use bgcolor=none to disable use of any background color
- bgdir - directory containing background images
- bgopacity - set opacity for background image, values 0...1.0
- tmin - background picture will be shown at least `tmin` seconds, no matter how frequently the RSS feed consumer accesses the page.
Important: bgcolor and bgdir will be evaluated by `{ <perl special> }` use quotes for absolute values!

Generated Readings/Events:

- state - show time and date of last layout evaluation

Layout definition

All parameters in curly brackets can be evaluated by `{ <perl special> }`
- `area <id> <x1> <y1> <x2> <y2> <{link}>`
  create a responsive area which will call a link when clicked.
  id = element id
  x1,y1 = upper left corner
  x2,y2 = lower right corner
  link = url to be called
- `boxcolor <{rgba}>`
  define an rgb color code to be used for filling button and textbox
- `button <id> <x1> <y1> <x2> <y2> <r1> <r2> <link> <text>`
  create a responsive colored button which will call a link when clicked.
  id = element id
  x1,y1 = upper left corner
  x2,y2 = lower right corner
  r1,r2 = radius for rounded corners
  link = url to be called
  text = text that will be written onto the button
  button will be filled with color defined by "boxcolor"
  text color will be read from "rgb" value
- `buttonpanel`
  needed once in your layout file if you intend to use buttons in the same layout.
- `circle <id> <x> <y> <r> [<fill>] [<stroke-width>] [<link>]`
  create a circle
  id = element id
  x,y = center coordinates of circle
  r = radius
  fill = circle will be filled with "rgb" color if set to 1. Default = 0
  stroke-width = defines stroke width to draw around the circle. Default = 0
  link = URL to be linked to item
- `counter <id> <x> <y>`
  print internal counter
  id = element id
  x,y = position
- `date <id> <x> <y>`
  print date
  id = element id
  x,y = position
- `embed <id> <x> <y> <width> <height> <{object}>`
  embed any object
  id = element id
  x,y = position
  width,height = containers's dimension
  object = object to embed
- `ellipse <id> <x> <y> <r1> <r2> [<fill>] [<stroke-width>] [<link>]`
  create an ellipse
  id = element id
  x,y = center coordinates of ellipse
  r1,r2 = radius
  fill = ellipse will be filled with "rgb" color if set to 1. Default = 0
  stroke-width = defines stroke width to draw around the ellipse. Default = 0
  link = URL to be linked to item
- `font <font-family>`
  define font family used for text elements (text, date, time, seconds ...)
  Example: `font arial`
- `group <id> open <x> <y>
  group - close` (id will not be evaluated, just give any value)
  group items
  open|close = define start and end of group
  x,y = upper left corner as reference for all grouped items, will be inherited to all elements.
  Examples:
  `group - open 150 150
  rect ...
  img ...
  group - close
  `
- `img <id> <x> <y> <scale> <link> <sourceType> <{dataSource}>s`
  embed an image into InfoPanel
  id = element id
  x,y = upper left corner
  scale = scale to be used for resizing; may be factor or defined by width or height
  link = URL to be linked to item, use "" if not needed
  sourceType = file | url | data
  dataSource = where to read data from, depends on sourceType
- `line <id> <x1> <y1> <x2> <y2> [<stroke>]`
  draw a line
  id = element id
  x1,y1 = coordinates (start)
  x2,y2 = coordinates (end)
  stroke = stroke width for line; if omitted, default = 0
- `moveby <x> <y>`
  move most recently x- and y-coordinates by given steps
- `movecalculated <{perlSpecial x}> <{perlSpecial y}>`
  calculate x- and y-coordinates by perlSpecials
- `moveto <x> <y>`
  move x- and y-coordinates to the given positon
- `padding <width>`
  border width (in pixel) to be used in textboxes
- `plot <id> <x> <y> <scale> <inline> <{plotName}>`
  embed an SVG plot into InfoPanel
  id = element id
  x,y = upper left corner
  scale = scale to be used for resizing; may be factor or defined by width or height
  inline = embed plot as data (inline=1) or as link (inline=0)
  plotName = name of desired SVG device from your fhem installation
- `pop`
  fetch last parameter set from stack and set it actice
- `pt <[+-]font-size>`
  define font size used for text elements (text, date, time, seconds ...)
  can be given as absolute or relative value.
  Examples:
  `pt 12`
  `pt +3`
  `pt -2`
- `push`
  push active parameter set onto stack
- `rect <id> <x1> <y1> <x2> <y2> <r1> <r2> [<fill>] [<stroke-width>] [<link>]`
  create a rectangle
  id = element id
  x1,y1 = upper left corner
  x2,y2 = lower right corner
  r1,r2 = radius for rounded corners
  fill = rectangle will be filled with "rgb" color if set to 1. Default = 0
  stroke-width = defines stroke width to draw around the rectangle. Default = 0
  link = URL to be linked to item
- `rgb <{rgb[a]}>`
  define rgba value (hex digits!) used for text, lines, circles, ellipses
  `r = red value`
  `g = green value`
  `b = blue value`
  `a = alpha value used for opacity; optional`
- `seconds <id> <x> <y> [<format>]`
  print seconds
  id = element id
  x,y = position
  format = seconds will be preceeded by ':' if set to 'colon'; optional
- `text <id> <x> <y> <{text}>`
  print text
  id = element id
  x,y = position
  text = text content to be printed
- `textbox <id> <x> <y> <boxWidth> <boxHeight> <{link}> <{text}>`
  create a textbox to print text with auto wrapping
  id = element id
  x,y = upper left corner
  boxWidth,boxHeight = dimensions of textbox
  link = url to be used when clicked; use "" if not needed
  text = text to be printed in textbox
  Important: textboxes are not responsive via area tag. Use optional link parameter in textbox tag
- `textboxalign <align>`
  define horizontal alignment for text inside textboxes
  valid values: left center right justify
- `textdesign <align>`
  define comma-separated list for text design and decoration
  valid values: underline overline line-through bold italic oblique clear
  Examples:
  `textdesign underline
  textdesign bold,italic,underline`
  Important: "clear" resets all to default values!
- `thalign <align>`
  define horizontal alignment for text output
  valid values: start middle end
- `ticker <id> <x> <y> <width> <items> <speed> <{data}>`
  create a vertical ticker
  id = element id
  x,y = position
  width = width
  items = number of items to be displayed simultanously
  speed = scroll speed
  data = list of text items, separated by `\n`
- `time <id> <x> <y>`
  print time
  id = element id
  x,y = position
- `tvalign <align>`
  define vertical alignment for text output
  valid values: auto baseline middle center hanging

Author's notes

- Have fun!

### Itach_IR

Defines a device representing a physical Itach IR. Serves as communication layer for Itach_IRDevice.
For more information, check the Wiki page.
Define

`define <name> Itach_IR <IP-address>`
Example:
`define Itach Itach_IR 192.168.1.2`

Set

N/A

Get

N/A

Attributes

- verbose
- timeout
  Can be used to change the timeout-value for tcp-communication. Default is 2.0.

### Itach_IRDevice

Itach IR is a physical device that serves to emit Infrared (IR) commands, hence it is a general IR remote control that can be controlled via WLAN (WF2IR) or LAN (IP2IR).
Using the iLearn-Software that ships with every Itach IR, record the IR-squences per original remotecontrol-button and store all these IR-codes as an IR-config-file. This IR-config-file can then be used directly with this module. All commands stored in the IR-config-file will be available immediately for use.
For more information, check the Wiki page.
Define

`define <name> Itach_IRDevice <IR-config-file>`
Store the IR-config-file in the same directory where fhem.cfg resides.
Hint: define an Itach_IR device first!
Example:
`define IR_mac Itach_IRDevice IR-codes-mac.txt`
`define IR_amp Itach_IRDevice IR-codes-media-amplifier.txt`

Set
`set <name> <command> [<parameter>]`
The list of available commands depends on the content of the IR-config-file.
There are only two module specific commands:

- `set <name> rereadIRfile`
  For performance reasons, the IR-config-File is read into memory upon definition of the device. If you change the configuration within that file, use this set-command to read its content into fhem once again.
- `set <name> seqsingle <parameter>`
  Will send the digits of a sequence one after the other. Useful when you have a sequence of digits to be sent, e.g. 123. Each digit must be a valid command in your IR-config-file.

Get

- `get <name> validcommands`
  Lists the valid commands for this device according to your IR-config-file.

Attributes

- verbose
- IODev
  Needs to be stated if more than one ItachIR-device is part of your fhem-configuration.

### ITACH_RELAY

Note: this module needs the Net::Telnet module.
Define

`define <name> ITACH_RELAY <ip-address> <port>`
Defines an Global Cache iTach Relay device (Box with 3 relays) via its ip address.
Examples:

`define motor1 ITACH_RELAY 192.168.8.200 1`

Set

`set <name> <value>`
where `value` is one of:

        off
        on
        toggle

Examples:

`set motor1 on`

Notes:

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

=item device =item summary reads OBIS data from measurement units =item summary_DE liest OBIS Daten von Messgeräten

### JSONMETER

This module reads data from a measurement unit (so called smart meters for electricity, gas or heat)
that provides OBIS compliant data in JSON format on a webserver or on the FHEM file system.
It assumes normally, that the structur of the JSON data do not change.
Define

`define <name> JSONMETER <deviceType> [<ip address>] [poll-interval]`
Example: `define powermeter JSONMETER ITF 192.168.178.20 300`
- `<deviceType>`
  Mandatory. Used to define the path and port to extract the json file.
  The attribute 'pathString' can be used to add login information to the URL path of predefined devices.
  - ITF - FROETEC Simplex ME one tariff electrical meter (N-ENERGY) (ITF Fröschl)
  - EFR - EFR Smart Grid Hub for electrical meter (EON, N-ENERGY and EnBW)
    use the 'pathstring' attribute to specifiy your login information
    `attr <device> pathString ?LogName=user&LogPSWD=password`
  - LS110 - YouLess LS110 network sensor (counter) for electro mechanical electricity meter
  - url - use the URL defined via the attributes 'pathString' and 'port'
  - file - use the file defined via the attribute 'pathString' (positioned in the FHEM file system)
- `[<ip address>]`
  IP address of the phyisical device. (not needed for 'url' and 'file')
- `[poll-interval]`
  Optional. Default is 300 seconds. Smallest possible value is 10. With 0 it will only update on "manual" request.

Set

- `activeTariff < 0 - 9 >`
  Allows the separate measurement of the consumption (doStatistics = 1) within different tariffs for all gages that miss this built-in capability (e.g. LS110). Also the possible gain of a change to a time-dependent tariff can be evaluated with this.
  This value must be set at the correct point of time in accordance to the existing or planned tariff by the FHEM command "at".
  0 = without separate tariffs
- `INTERVAL <polling interval>`
  Polling interval in seconds
- `resetStatistics <statReadings>`
  Deletes the selected statistic values: all, statElectricityConsumed..., statElectricityConsumedTariff..., statElectricityPower...
- `restartJsonAnalysis`
  Restarts the analysis of the json file for known readings (compliant to the OBIS standard).
  This analysis happens normally only once if readings have been found.
- `statusRequest`
  Update device information

Get

- `jsonFile`
  extracts and shows the json data
- `jsonAnalysis`
  extracts the json data and shows the result of the analysis

Attributes

- `alwaysAnalyse < 0 | 1 >`
  Repeats by each update the json analysis - use if structure of json data changes
  Normally the once analysed structure is saved to reduce CPU load.
- `doStatistics < 0 | 1 >`
  Builds daily, monthly and yearly statistics for certain readings (average/min/max or cumulated values).
  Logging and visualisation of the statistics should be done with readings of type 'statReadingName Last'.
- `pathString <string>`
  - if deviceType = 'file': specifies the local file name and path
  - if deviceType = 'url': specifies the url path
  - other deviceType: can be used to add login information to the url path of predefined devices
- `port <number>`
  Specifies the IP port for the deviceType 'url' (default is 80)
- `timeOut <seconds>`
  Specifies the timeout for the reading of the raw data. (default is 10)
  The run time of the reading process can be measured via "get <device> jsonFile".
- readingFnAttributes

### Jabber

This Module allows FHEM to connect to the Jabber Network, send and receiving messages from and to a Jabber server.
Jabber is another description for (XMPP) - a communications protocol for message-oriented middleware based on XML and - depending on the server - encrypt the communications channels.
For the user it is similar to other instant messaging Platforms like Facebook Chat, ICQ or Google's Hangouts but free, Open Source and by default encrypted between the Jabber servers.
You need an account on a Jabber Server, you can find free services and more information on jabber.org
Discuss the module in the specific thread here.
This Module requires the following perl Modules to be installed (using SSL):

- Net::Jabber
- Net::XMPP
- Authen::SASL
- XML::Stream
- Net::SSLeay

Since version 1.5 it allows FHEM also to join MUC (Multi-User-Channels) and the use of OTR for end to end encryption
If you want to use OTR you must compile and install Crypt::OTR from CPAN on your own.
Define

`define <name> Jabber <server> <port> <username> <password> <TLS> <SSL>`
You have to create an account on a free Jabber server or setup your own Jabber server.
Example:

`define JabberClient1 Jabber jabber.org 5222 myusername mypassword 1 0`

Set

- `set <name> msg <username> <msg>`
  sends a message to the specified username
  Examples:
  `set JabberClient1 msg myname@jabber.org It is working!`
- `set <name> msgmuc <channel> <msg>`
  sends a message to the specified MUC group channel
  Examples:
  `set JabberClient1 msgmuc roomname@jabber.org Woot!`
- `set <name> msgotr <username> <msg>`
  sends an Off-the-Record encrypted message to the specified username, if no OTR session is currently established it is being tried to esablish an OTR session with the specified user.
  If the user does not have OTR support the message is discarded.
  Examples:
  `set JabberClient1 msgotr myname@jabber.org Meet me at 7pm at the place today :*`
- `set <name> subscribe <username>`
  asks the username for authorization (not needed normally)
  Example:
  `set JabberClient1 subscribe myname@jabber.org`

Get

N/A

Attributes

- `OnlineStatus available|unavailable`
  Sets the online status of the client, available (online in Clients) or unavailable (offline in Clients)
  It is possible, on some servers, that FHEM can even recieve messages if the status is unavailable
  Default: `available`
- `ResourceName <name>`
  In XMPP/Jabber you can have multiple clients connected with the same username.
  The resource name finally makes the Jabber-ID unique to each client.
  Here you can define the resource name.
  Default: `FHEM`
- `PollTimer <seconds>`
  This is the interval in seconds at which the jabber server get polled.
  Every interval the client checks if there are messages waiting and checks the connection to the server.
  Don't set it over 10 seconds, as the client could get disconnected.
  Default: `2`
- `RecvWhitelist <Regex>`
  Only if the Regex match, the client accepts and interpret the message. Everything else will be discarded.
  Default: `.*`
  Examples:
  `myname@jabber.org`
  `(myname1@jabber.org|myname2@xmpp.de)`
- `MucJoin channel1@server.com/mynick[:password]`
  Allows you to join one or more MUC's (Multi-User-Channel) with a specific Nick and a optional Password
  Default: empty (no messages accepted)
  Examples:
  Join a channel: `channel1@server.com/mynick`
  Join more channels: `channel1@server.com/mynick,channel2@server.com/myothernick`
  Join a channel with a password set: `channel1@server.com/mynick:password`
- `MucRecvWhitelist <Regex>`
  Same as RecvWhitelist but for MUC: Only if the Regex match, the client accepts and interpret the message. Everything else will be discarded.
  Default: empty (no messages accepted)
  Examples:
  All joined channels allowed: `.*`
  Specific channel allowed only: `mychannel@jabber.org`
  Specific Nick in channel allowed only: `mychannel@jabber.org/NickOfFriend`
- `OTREnable 1|0`
  Enabled the use of Crypt::OTR for end to end encryption between a device and FHEM
  You must have Crypt::OTR installed and a private key is being generated the first time you enable this option
  Key generation can take more than 2 hours on a quiet system but will not block FHEM instead it will inform you if it has been finished
  Key generation is a one-time-task
  Default: empty (OTR disabled)
- `OTRSharedSecret aSecretKeyiOnlyKnow@@*`
  Optional shared secret to allow the other end to start a trust verification against FHEM with this shared key.
  If the user starts a trust verification process the fingerprint of the FHEM private key will be saved at the user's device and the connection is trusted.
  This will allow to inform the user if the private key has changed (ex. in Man-in-the-Middle attacks)
  Default: empty, please define a shared secret on your own.

Generated Readings/Events:

- Private Messages
  - Message - Complete message including JID and text
  - LastMessage - Only text portion of the Message
  - LastSenderJID - Only JID portion of the Message
- Encrypted Private Messages (if OTREnable=1)
  - OTRMessage - Complete decrypted message including JID and text
  - OTRLastMessage - Only text portion of the Message
  - OTRLastSenderJID - Only JID portion of the Message
- MUC Room Messages (if MUCJoin is set)
  - MucMessage - Complete message including room's JID and text
  - MucLastMessage - Only text portion of the Message
  - MucLastSenderJID - Only JID portion of the Message

Author's Notes:

- You can react and reply on incoming private messages with a notify like this:

      define Jabber_Notify notify JabberClient1:Message.* {
        my $lastsender=ReadingsVal("JabberClient1","LastSenderJID","0");
        my $lastmsg=ReadingsVal("JabberClient1","LastMessage","0");
        my $temperature=ReadingsVal("BU_Temperatur","temperature","0");
        fhem("set JabberClient1 msg ". $lastsender . " Temp: ".$temperature);
      }

- You can react and reply on MUC messages with a notify like this, be aware that the nickname in $lastsender is stripped off in the msgmuc function

      define Jabber_Notify notify JabberClient1:MucMessage.* {
        my $lastsender=ReadingsVal("JabberClient1","LastSenderJID","0");
        my $lastmsg=ReadingsVal("JabberClient1","LastMessage","0");
        my $temperature=ReadingsVal("BU_Temperatur","temperature","0");
        fhem("set JabberClient1 msgmuc ". $lastsender . " Temp: ".$temperature);
      }

- You can react and reply on OTR private messages with a notify like this:

      define Jabber_Notify notify JabberClient1:OTRMessage.* {
        my $lastsender=ReadingsVal("JabberClient1","LastSenderJID","0");
        my $lastmsg=ReadingsVal("JabberClient1","LastMessage","0");
        my $temperature=ReadingsVal("BU_Temperatur","temperature","0");
        fhem("set JabberClient1 msgotr ". $lastsender . " Temp: ".$temperature);
      }

### JawboneUp

This module supports the Jawbone Up[24] fitness tracker. The module collects calories, steps and distance walked (and a few other metrics) on a given day.
All communication with the Jawbone services is handled as background-tasks, in order not to interfere with other FHEM services.
Installation Among the perl modules required for this module are: LWP::UserAgent, IO::Socket::SSL, WWW::Jawbone::Up.
At least WWW:Jawbone::Up doesn't seem to have a debian equivalent, so you'll need CPAN to install the modules.
Example: `cpan -i WWW::Jawbone::Up` should install the required perl modules for the Jawbone up.
Unfortunately the WWW::Jawbone::Up module relies on quite a number of dependencies, so in case of error, check the CPAN output for missing modules.
Some dependent modules might fail during self-test, in that case try a forced install: `cpan -i -f module-name`
Error handling If there are more than three consecutive API errors, the module disables itself. A "get update" re-enables the module.
API errors can be caused by wrong credentials or missing internet-connectivity or by a failure of the Jawbone server.
Configuration Define

`define <name> JawboneUp <user> <password> [<interval>]`
Defines a JawboneUp device.
Parameters

- name
  A name for your jawbone device.
- user
  Username (email) used as account-name for the jawbone service.
- password
  The password for the jawbone service.
- interval
  Optional polling intervall in seconds. Default is 3600, minimum is 300 (=5min). It is not recommended to go below 900sec.

Example:

`define myJawboneUp JawboneUp me@foo.org myS3cret 3600`
`attr myJawboneUp room Jawbone`

Readings

- active_time
  (Active time (seconds))
- bg_steps
  (Step count)
- bmr_calories
  (Resting calories)
- bmr_calories_day
  (Average daily calories (without activities))
- calories
  (Activity calories)
- distance
  (Distance in km)
- longest_idle
  (Inactive time in seconds)
- sleep_awake
  (Awake time during sleep in seconds)
- sleep_asleep
  (Actual sleep during sleep period, time in seconds)
- awakenings
  (Awakenings)
- light
  (Light sleep during sleep period, time in seconds)
- time_to_sleep
  (Time to fall asleep in seconds)
- bedtime
  (Time in bed)
- deep
  (Deep sleep in seconds)
- awake
  (Time awake in seconds)
- sleep_mode
  (0: sleep mode inactive, 1: sleep mode active) Note: this is not real-time since updates depend on the module's poll-intervall
- stopwatch_mode
  (0: not in stopwatch mode, 1: stopwatch mode active) Note: not suitable for real-time measurements for the reasons above.

Get

- update
  trigger an update

Attributes

- interval
  the interval in seconds for updates. the default ist 3600 (=1h), minimum is 300 (=5min). It is not recommended to go below 900sec.
- disable
  1 -> disconnect and stop polling

### JeeLink

The JeeLink is a family of RF devices sold by jeelabs.com. It is possible to attach more than one device in order to get better reception, fhem will filter out duplicate messages.
This module provides the IODevice for:

- PCA301 modules that implement the PCA301 protocol.
- LaCrosse modules that implement the IT+ protocol (Sensors like TX29DTH, TX35, ...).
- LevelSender for measuring tank levels
- EMT7110 energy meter
- Other Sensors like WT440XH (their protocol gets transformed to IT+)

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> JeeLink <device>`
USB-connected devices:

<device> specifies the serial port to communicate with the JeeLink. 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 JeeLink by the following command:

modprobe usbserial vendor=0x0403 product=0x6001

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@57600
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.

Set

- raw <data>
  send <data> to the JeeLink. Depending on the sketch running on the JeeLink, different commands are available. Most of the sketches support the v command to get the version info and the ? command to get the list of available commands.
- reset
  force a device reset closing and reopening the device.
- LaCrossePairForSec <sec> [ignore_battery]
  enable autocreate of new LaCrosse sensors for <sec> seconds. If ignore_battery is not given only sensors sending the 'new battery' flag will be created.
- flash [firmwareName]
  The JeeLink needs the right firmware to be able to receive and deliver the sensor data to fhem. In addition to the way using the arduino IDE to flash the firmware into the JeeLink this provides a way to flash it directly from FHEM.
  The firmwareName argument is optional. If not given, set flash checks the firmware type that is currently installed on the JeeLink and updates it with the same type.
  There are some requirements:
  - avrdude must be installed on the host
    On a linux systems like Cubietruck or Raspberry Pi this can be done with: sudo apt-get install avrdude
  - the flashCommand attribute must be set.
    This attribute defines the command, that gets sent to avrdude to flash the JeeLink.
    The default is: avrdude -p atmega328P -c arduino -P [PORT] -D -U flash:w:[HEXFILE] 2>[LOGFILE]
    It contains some place-holders that automatically get filled with the according values:
    - [PORT]
      is the port the JeeLink is connectd to (e.g. /dev/ttyUSB0)
    - [HEXFILE]
      is the .hex file that shall get flashed. There are three options (applied in this order):
      - passed in set flash
      - taken from the hexFile attribute
      - the default value defined in the module
    - [LOGFILE]
      The logfile that collects information about the flash process. It gets displayed in FHEM after finishing the flash process
- led <on|off>
  Is used to disable the blue activity LED
- beep
  ...
- setReceiverMode
  ...

Get

Attributes

- Clients
  The received data gets distributed to a client (e.g. LaCrosse, EMT7110, ...) 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 JeeLink module, you must add it to the Clients attribute.
- MatchList
  can be set to a perl expression that returns a hash that is used as the MatchList
  `attr myJeeLink MatchList {'5:AliRF' => '^\\S+\\s+5 '}`
- initCommands
  Space separated list of commands to send for device initialization.
  This can be used e.g. to bring the LaCrosse Sketch into the data rate toggle mode. In this case initCommands would be: 30t
- flashCommand
  See "Set flash"
- timeout
  format: <timeout, checkInterval> Checks every 'checkInterval' seconds if the last data reception is longer than 'timout' seconds ago.
  If this is the case, a reset is done for the IO-Device.

### JsonList

Note: this command is deprecated, use jsonlist2 instead.
`jsonlist [<devspec>|<typespec>|ROOMS]`
Returns an JSON tree of all definitions, all notify settings and all at entries if no parameter is given. Can also be called via HTTP by http://fhemhost:8083/fhem?cmd=jsonlist&XHR=1
Example:

      fhem> jsonlist
      {
        "ResultSet": "full",
        "Results": [
          {
            "list": "Global",
            "devices": [
              {
                "DEF": "<no definition>",
                "NAME": "global",
                "NR": "1",
                "STATE": "<no definition>",
                "TYPE": "Global",
                "currentlogfile": "/var/log/fhem/fhem-2011-12.log",
                "logfile": "/var/log/fhem/fhem-%Y-%m.log",
                "ATTR": {
                  "configfile": "/etc/fhem/fhem.conf",
                  "logfile": "/var/log/fhem/fhem-%Y-%m.log",
                  "modpath": "/usr/share/fhem",
                  "pidfilename": "/var/run/fhem.pid",
                  "port": "7072 global",
                  "room": "Server",
                  "statefile": "/var/cache/fhem/fhem.save",
                  "verbose": "4",
                  "version": "5.8 from 2017-02-19 ($Id: 98_JsonList.pm 12275 2016-10-05 14:33:55Z rudolfkoenig $)"
                },
                "READINGS": []
              }
            ]
          },
          {
          "list": "CM11",
            "devices": [
              {
                "DEF": "/dev/cm11",
                "DeviceName": "/dev/cm11",
                "FD": "14",
                "NAME": "CM11",
                "NR": "19",
                "PARTIAL": "null",
                "STATE": "Initialized",
                "TYPE": "CM11",
                "ATTR": {
                  "model": "CM11"
                },
                "READINGS": []
              }
            ]
          },
          {
                  [...placeholder for more entrys...]
          },
        ],
        "totalResultsReturned": 235
      }

If specifying `<devspec>`, then a detailed status for `<devspec>` will be displayed, e.g.:

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

If specifying `<typespec>`, then a list with the status for the defined `<typespec>` devices will be displayed, e.g.:

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

If specifying `ROOMS`, then a list with the defined rooms will be displayed, e.g.:

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

### JsonList2

`jsonlist [<devspec>] [<value1> <value2> ...]`
This is a command, to be issued on the command line (FHEMWEB or telnet interface). Can also be called via HTTP by

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

Returns an JSON tree of the internal values, readings and attributes of the requested definitions.
If valueX is specified, then output only the corresponding internal (like DEF, TYPE, etc), reading (actuator, measured-temp) or attribute for all devices from the devspec.
Note: the old command jsonlist (without the 2 as suffix) is deprecated and will be removed in the future

### KM271

KM271 is the name of the communication device for the Buderus Logamatic 2105 or 2107 heating controller. It is connected via a serial line to the fhem computer. The fhem module sets the communication device into log-mode, which then will generate an event on change of the inner parameters. There are about 20.000 events a day, the FHEM module ignores about 90% of them, if the all_km271_events attribute is not set.
Note: this module requires the Device::SerialPort or Win32::SerialPort module.
Define

`define <name> KM271 <serial-device-name>`
Example:

`define KM271 KM271 /dev tyS0@2400`

Set

`set KM271 <param> [<value> [<values>]]`
where param is one of:

- hk1_tagsoll <temp>
  sets the by day temperature for heating circuit 1
  0.5 celsius resolution - temperature between 10 and 30 celsius
- hk2_tagsoll <temp>
  sets the by day temperature for heating circuit 2
  (see above)
- hk1_nachtsoll <temp>
  sets the by night temperature for heating circuit 1
  (see above)
- hk2_nachtsoll <temp>
  sets the by night temperature for heating circuit 2
  (see above)
- hk1_urlaubsoll <temp>
  sets the temperature during holiday mode for heating circuit 1
  (see above)
- hk2_urlaubsoll <temp>
  sets the temperature during holiday mode for heating circuit 2
  (see above)
- hk1_aussenhalt_ab <temp>
  sets the threshold for working mode Aussenhalt for heating circuit 1
  1.0 celsius resolution - temperature between -20 and 10 celsius
- hk2_aussenhalt_ab <temp>
  sets the threshold for working mode Aussenhalt for heating circuit 2
  (see above)
- hk1_betriebsart [automatik|nacht|tag]
  sets the working mode for heating circuit 1
  - automatik: the timer program is active and the summer configuration is in effect
  - nacht: manual by night working mode, no timer program is in effect
  - tag: manual by day working mode, no timer program is in effect
- hk2_betriebsart [automatik|nacht|tag]
  sets the working mode for heating circuit 2
  (see above)
- ww_soll <temp>
  sets the hot water temperature
  1.0 celsius resolution - temperature between 30 and 60 celsius
- ww_betriebsart [automatik|nacht|tag]
  sets the working mode for hot water
  - automatik: hot water production according to the working modes of both heating circuits
  - nacht: no hot water at all
  - tag: manual permanent hot water
- ww_on-till [localtime]
  start hot water production till the given time is reached
  localtime must have the format HH:MM[:SS]
  ww_betriebsart is set according to the attribut ww_timermode. For switching-off hot water a single one-time at command is automatically generated which will set ww_betriebsart back to nacht
- ww_zirkulation [count]
  count pumping phases for hot water circulation per hour
  count must be between 0 and 7 with special meaning for
  - 0: no circulation at all
  - 7: circulation is always on
- sommer_ab <temp>
  temp defines the threshold for switching between summer or winter mode of the heater
  1.0 celsius resolution - temp must be between 9 and 31 with special meaning for
  - 9: fixed summer mode (only hot water and frost protection)
  - 31: fixed winter mode
- frost_ab <temp>
  temp defines the threshold for activation of frost protection of the heater
  1.0 celsius resolution - temp must be between -20 and 10 celsius
- urlaub [count]
  sets the duration of the holiday mode to count days
  count must be between 0 and 99 with special meaning for
  - 0: holiday mode is deactivated
- hk1_programm [eigen|familie|frueh|spaet|vormittag|nachmittag|mittag|single|senior]
  sets the timer program for heating circuit 1
  - eigen: the custom program defined by the user (see below) is used
  - all others: predefined programs from Buderus for various situations (see Buderus manual for details)
- hk2_programm [eigen|familie|frueh|spaet|vormittag|nachmittag|mittag|single|senior]
  sets the timer program for heating circuit 2
  (see above)
- hk1_timer [<position> delete|<position> <on-day> <on-time> <off-day> <off-time>]
  sets (or deactivates) a by day working mode time interval for the custom program of heating circuit 1
  - position: addresses a slot of the custom timer program and must be between 1 and 21
    The slot will be set to the interval specified by the following on- and off-timepoints or is deactivated when the next argument is delete.
  - on-day: first part of the on-timepoint
    valid arguments are [mo|di|mi|do|fr|sa|so]
  - on-time: second part of the on-timepoint
    valid arguments have the format HH:MM (supported resolution: 10 min)
  - off-day: first part of the off-timepoint
    (see above)
  - off-time: second part of the off-timepoint
    valid arguments have the format HH:MM (supported resolution: 10 min)
  As the on-timepoint is reached, the heating circuit is switched to by day working mode and when the off-timepoint is attained, the circuit falls back to by night working mode. A program can be build up by chaining up to 21 of these intervals. They are ordered by the position argument. There's no behind the scene magic that will automatically consolidate the list. The consistency of the program is in the responsibility of the user.
  Example:
  `set KM271 hk1_timer 1 mo 06:30 mo 08:20`
  This will toogle the by day working mode every Monday at 6:30 and will fall back to by night working mode at 8:20 the same day.
- hk2_timer [<position> delete|<position> <on-day> <on-time> <off-day> <off-time>]
  sets (or deactivates) a by day working mode time interval for the custom program of heating circuit 2
  (see above)
- logmode
  set to logmode / request all readings again

Get

`get KM271 <param>`
where param is one of:

- l_fehler
  gets the latest active error (code and message)
- l_fehlerzeitpunkt
  gets the timestamp, when the latest active error occured (format of Perl-function 'time')
- l_fehleraktualisierung
  gets the timestamp, of the latest update of an error status (format of Perl-function 'time')

Attributes

- do_not_notify
- all_km271_events
  If this attribute is set to 1, do not ignore following events:
  HK1_Vorlaufisttemperatur, HK1_Mischerstellung, HK2_Vorlaufisttemperatur, HK2_Mischerstellung, Kessel_Vorlaufisttemperatur, Kessel_Integral, Kessel_Integral1
  These events account for ca. 92% of all events.
  All UNKNOWN events are ignored too, most of them were only seen directly after setting the device into logmode.
- ww_timermode [automatik|tag]
  Defines the working mode for the ww_on-till command (default is tag).
  ww_on-till will set the ww_betriebsart of the heater according to this attribute.
- readingsFilter
  Regular expression for selection of desired readings.
  Only readings which will match the regular expression will be used. All other readings are suppressed in the device and even in the logfile.
- additionalNotify
  Regular expression for activation of notify for readings with normally suppressed events.
  Useful for *_Vorlaufisttemperatur readings if notification should be activated only for a specific reading and not for all like all_km271_events.

Generated events:

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

As I cannot explain all the values, I logged data for a period and plotted each received value in the following logs:

- Aussentemperatur
- Betriebswerte
- Brenneransteuerung
- Brennerlaufzeit
- Brennerschalttemperatur
- Heizkennlinie
- Kesselbetrieb
- Kesselintegral
- Ladepumpe
- Raumsolltemperatur_HK1
- Vorlauftemperatur
- Warmwasser

All of these events are reported directly after initialization (or after requesting logmode), along with some 60 configuration records (6byte long each). Most parameters from these records are reverse engeneered, they all start with CFG_ for configuration and PRG_ for timer program information.

### KM273

KM273 implements the can bus communication with the buderus logatherm wps heat pump
The software expect an SLCAN compatible module like USBtin
Define

`define <name> KM273 <device>`
Example: `define myKM273 KM273 /dev/ttyACM0@115200`

Set

`set <name> <option> <value>`
Example:
`set myKM273 DHW_TIMEPROGRAM 1`
`set myKM273 DHW_TIMEPROGRAM Always_On`
You can set any value to any of the following options.
Options:

- DHW_CALCULATED_SETPOINT_TEMP
  preset hot water temperature
- DHW_TIMEPROGRAM
  select: '0' or 'Always_On', '1' or 'Program_1', '2' or 'Program_2'
- DHW_PROGRAM_MODE
  select: '0' or 'Automatic', '1' or 'Always_On', '2' or 'Always_Off'
- DHW_PROGRAM_1_1MON .. ROOM_PROGRAM_1_7SUN
  value: 06:00 on 21:00 off
- DHW_PROGRAM_2_1MON .. ROOM_PROGRAM_2_7SUN
  value: 06:00 on 21:00 off
- PUMP_DHW_PROGRAM1_START_TIME .. PUMP_DHW_PROGRAM4_STOP_TIME
  dayly program for switching on and off the hot water circulation pump
  you can set 4 time ranges where the pump should be switched on value: xx:xx
- ROOM_TIMEPROGRAM
  select: '0' or 'HP_Optimized', '1' or 'Program_1', '2' or 'Program_2', '3' or 'Family', '4' or 'Morning', '5' or 'Evening', '6' or 'Seniors'
- ROOM_PROGRAM_MODE
  select: '0' or 'Automatic', '1' or 'Off', '2' or 'Day', '3' or 'Night'
- ROOM_PROGRAM_1_1MON .. ROOM_PROGRAM_1_7SUN
  value: 06:00 on 21:00 off
- ROOM_PROGRAM_2_1MON .. ROOM_PROGRAM_2_7SUN
  value: 06:00 on 21:00 off

Get

`get <name> <option>`
You can get the value of any of the options described in paragraph "Set" above. See commandref#get for more info about the get command.

Attributes

`attr <name> <attribute> <value>`
See commandref#attr for more info about the attr command.
Attributes:

- DoNotPoll 0|1
  When you set DoNotPoll to "1", the module is only listening to the telegrams on CAN bus. Default is "0".

### KNX

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

For getting started, please refer to this document: KNX-Basics

While the module TUL represents the connection to the KNX network, the KNX modules represent individual KNX devices. This module provides a basic set of operations (on, off, on-until, on-for-timer) to switch on/off KNX devices. For numeric DPT you can use value (set <devname> value <177.45>). For string-DPT you can use string (set <devname> string <Hello World>). For other, non-defined dpt you can send raw hex values to the network (set <devname> raw <hexval>).
Sophisticated setups can be achieved by combining a number of KNX module instances. Therefore you can define a number of different GAD/DPT combinations per each device.

KNX defines a series of Datapoint Type as standard data types used to allow general interpretation of values of devices manufactured by different companies. These datatypes are used to interpret the status of a device, so the state in FHEM will then show the correct value. For each received telegram there will be a reading with state, getG<group> and the sender address. For every set, there will be a reading with state and setG<group>.

Define

`define <name> KNX <group>:<DPT>:<[;readingName]> [<group>:<DPT> ..] [IODev]`

A KNX device need a concrete DPT. Please refer to Available DPT. Otherwise the system cannot en- or decode the messages. Furthermore you can supply a IO-Device directly at startup. This can be done later on via attribute as well.

Define an KNX device, connected via a TUL. The <group> parameters are either a group name notation (0-15/0-15/0-255) or the hex representation of the value (0-f0-f0-ff). All of the defined groups can be used for bus-communication. Without further attributes, all incoming messages are translated into state. Per default, the first group is used for sending. If you want to send via a different group, you have to index it (set <devname> value <17.0> <g2>).
If you use the readingName, readings are based on this name (e.g. hugo-set, hugo-get for name hugo).

The module autocreate is creating a new definition for any unknown sender. The device itself will be NOT fully available, until you added a DPT to the definition. The name will be KNX_nnmmooo where nn is the line adress, mm the area and ooo the device.

Example:

          define lamp1 KNX 0/10/12:dpt1
          define lamp1 KNX 0/10/12:dpt1:meinName 0/0/5:dpt1.001
          define lamp1 KNX 0A0C:dpt1.003 myTul

One hint regarding dpt1 (binary): all the sub-types have to be used with keyword value. Received telegrams are already encoded to their representation. Having the on/off button (for send values) without keyword value is an absolutely special use-case and only valid for dpt1 (not the subs).

Example:

          define rollo KNX 0/10/12:dpt1.008
    	  set rollo value up
    	  set rollo value down

Set

`set <name> <on, off>` [g<groupnr>] `set <name> <on-for-timer, on-until> <time> [g<groupnr>]` `set <name> <value> [g<groupnr>]` `set <name> <string> [g<groupnr>]` `set <name> <raw> [g<groupnr>]`

Example:

          set lamp1 on
          set lamp1 off
          set lamp1 on-for-timer 10
          set lamp1 on-until 13:15:00
          set foobar raw 234578
          set thermo value 23.44
    	  set message value Hallo Welt

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

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

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

          define dim1 KNX 0/0/5:dpt5.001
          attr dim1 slider 0,1,100
          attr dim1 webCmd value

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

          define timedev KNX 0/0/7:dpt10
          attr timedev webCmd now

          define datedev KNX 0/0/8:dpt11
          attr datedev webCmd now

          # send every midnight the new date
          define dateset at *00:00:00 set datedev now

          # send every hour the current time
          define timeset at +*01:00:00 set timedev now

Get

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

Attributes

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

format

The content of this attribute is added to every received value, before this is copied to state.

Example:

          define myTemperature KNX 0/1/1:dpt5
          attr myTemperature format °C;

stateRegex

You can pass n pairs of regex-pattern and string to replace, seperated by a slash. Internally the "new" state is always in the format getG<group>:<state-value>. The substitution is done every time, a new object is received. You can use this function for converting, adding units, having more fun with icons, ... This function has only an impact on the content of state - no other functions are disturbed. It is executed directly after replacing the reading-names and setting the formats, but before stateCmd

Example:

          define myLamp KNX 0/1/1:dpt1 0/1/2:dpt1 0/1/2:dpt1
          attr myLamp stateRegex /getG1:/steuern:/ /getG2:/status:/ /getG3:/sperre:/ /setG[13]:/steuern:/ /setG[3]://
    	  attr myLamp devStateIcon status.on:general_an status.off:general_aus sperre.on:lock steuern.*:hourglass

stateCmd

You can supply a perl-command for modifying state. This command is executed directly before updating the reading - so after renaming, format and regex. Please supply a valid perl command like using the attribute stateFormat. Unlike stateFormat the stateCmd modifies also the content of the reading, not only the hash-conten for visualization.

Example:

          define myLamp KNX 0/1/1:dpt1 0/1/2:dpt1 0/1/2:dpt1
          attr myLamp stateCmd {$state = sprintf("%s", ReadingsVal($name,"getG2","undef"))}

answerReading

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

If set to 1, read-requests are answered

listenonly

If set to 1, the device may not send any messages. As well answering requests although get is prohibited.

readonly

If set to 1, the device may not send any messages. Answering requests are prohibited.Get is allowed.

slider

slider <min>,<step>,<max>
With this attribute you can add a slider to any device.

Example:

          define myDimmer KNX 0/1/1:dpt5
          attr myDimmer slider 0,1,100
    	  attr myDimmer webCmd value

DPT - datapoint-types

The following dpt are implemented and have to be assigned within the device definition.

dpt1 on, off
dpt1.001 on, off
dpt1.002 true, false
dpt1.003 enable, disable
dpt1.008 up, down
dpt1.009 open, closed
dpt1.019 closed, open
dpt3 -100..+100
dpt5 0..255
dpt5.001 0..100 %
dpt5.003 0..360 °
dpt5.004 0..255 %
dpt6 -127..+127
dpt6.001 0..100 %
dpt7 0..65535
dpt7.001 0..65535 s
dpt7.005 0..65535 s
dpt7.005 0..65535 m
dpt7.012 0..65535 mA
dpt7.013 0..65535 lux
dpt8 -32768..32768
dpt8.005 -32768..32768 s
dpt8.010 -32768..32768 %
dpt8.011 -32768..32768 °
dpt9 -670760.0..+670760.0
dpt9.001 -670760.0..+670760.0 °
dpt9.004 -670760.0..+670760.0 lux
dpt9.005 -670760.0..+670760.0 m/s
dpt9.006 -670760.0..+670760.0 Pa
dpt9.007 -670760.0..+670760.0 %
dpt9.008 -670760.0..+670760.0 ppm
dpt9.009 -670760.0..+670760.0 m�/h
dpt9.010 -670760.0..+670760.0 s
dpt9.021 -670760.0..+670760.0 mA
dpt9.024 -670760.0..+670760.0 kW
dpt9.025 -670760.0..+670760.0 l/h
dpt9.026 -670760.0..+670760.0 l/h
dpt9.028 -670760.0..+670760.0 km/h
dpt10 01:00:00
dpt11 01.01.2000
dpt12 0..+Inf
dpt13 -Inf..+Inf
dpt13.010 -Inf..+Inf Wh
dpt13.013 -Inf..+Inf kWh
dpt14 -Inf.0..+Inf.0
dpt14.019 -Inf.0..+Inf.0 A
dpt14.027 -Inf.0..+Inf.0 V
dpt14.056 -Inf.0..+Inf.0 W
dpt14.068 -Inf.0..+Inf.0 °C;
dpt14.076 -Inf.0..+Inf.0 m³
dpt16 String;
dpt16.000 ASCII-String;
dpt16.001 ISO-8859-1-String (Latin1);
dpt232 RGB-Value RRGGBB

### KODI

Define

`define <name> KODI <ip[:port]> <http|tcp> [<username>] [<password>]`
This module allows you to control Kodi and receive events from Kodi. It can also be used to control Plex (see attribute compatibilityMode).
Prerequisites

- Requires XBMC "Frodo" 12.0.
- To use this module you will have to enable JSON-RPC. See here.
- The Perl module JSON is required.
  On Debian/Raspbian: `apt-get install libjson-perl`
  Via CPAN: `cpan install JSON` To get it working on a Fritzbox the JSON module has to be installed manually.

To receive events it is necessary to use TCP. The default TCP port is 9090. Username and password are optional for TCP. Be sure to enable JSON-RPC for TCP. See here.
Example:

`define htpc KODI 192.168.0.10 tcp
define htpc KODI 192.168.0.10:9000 tcp # With custom port
define htpc KODI 192.168.0.10 http # Use HTTP instead of TCP - Note: to receive events use TCP!
define htpc KODI 192.168.0.10 http kodi passwd # Use HTTP with credentials - Note: to receive events use TCP!`

Remote control:
There is an simple remote control layout for Kodi which contains the most basic buttons. To add the remote control to the webinterface execute the following commands:

`define <rc_name> remotecontrol #adds the remote control
set <rc_name> layout KODI_RClayout #sets the layout for the remote control
set <rc_name> makenotify <KODI_device> #links the buttons to the actions`

Known issues:
Kodi sometimes creates events twices. For example the Player.OnPlay event is created twice if play a song. Unfortunately this is a issue of Kodi. The fix of this bug is included in future version of Kodi (> 12.2).

Set

`set <name> <command> [<parameter>]`
This module supports the following commands:
Player related commands:

- play [<all|audio|video|picture>] - starts the playback (might only work if previously paused). The second argument defines which player should be started. By default the active players will be started
- pause [<all|audio|video|picture>] - pauses the playback
- playpause [<all|audio|video|picture>] - toggles between play and pause for the given player
- stop [<all|audio|video|picture>] - stop the playback
- next [<all|audio|video|picture>] - jump to the next track
- prev [<all|audio|video|picture>] - jump to the previous track or the beginning of the current track.
- goto <position> [<audio|video|picture>] - Goes to the <position> in the playlist. <position> has to be a number.
- shuffle [<toggle|on|off>] [<audio|video|picture>] - Enables/Disables shuffle mode. Without furhter parameters the shuffle mode is toggled.
- repeat <one|all|off> [<audio|video|picture>] - Sets the repeat mode.
- open <URI> - Plays the resource located at the URI (can be a url or a file)
- opendir <path> - Plays the content of the directory
- openmovieid <path> - Plays a movie by id
- openepisodeid <path> - Plays an episode by id
- openchannelid <path> - Switches to channel by id
- addon <addonid> <parametername> <parametervalue> - Executes addon with one Parameter, for example set kodi addon script.json-cec command activate
- seek <hh:mm:ss> - seek to the specified time

Input related commands:

- back - Back-button
- down - Down-button
- up - Up-button
- left - Left-button
- right - Right-button
- home - Home-button
- select - Select-button
- info - Info-button
- showosd - Opens the OSD (On Screen Display)
- showcodec - Shows Codec information
- exec <action> - Execute an input action. All available actions are listed here
- send <text> - Sends <text> as input to Kodi
- jsonraw - Sends raw JSON data to Kodi

Libary related commands:

- videolibrary clean - Removes non-existing files from the video libary
- videolibrary scan - Scan for new video files
- audiolibrary clean - Removes non-existing files from the audio libary
- audiolibrary scan - Scan for new audio files

Application related commands:

- activatewindow <name> - activates the window "name" of the following list:
  - AddonSearch
  - Addons
  - Albums
  - AndroidApps
  - Artists
  - Compilations
  - EventLog
  - FileManager
  - Genres
  - InProgressTvShows
  - MovieActors
  - MovieCountries
  - MovieDirectors
  - MovieGenres
  - MovieInformation
  - MovieSets
  - MovieStudios
  - MovieTags
  - MovieTitles
  - MovieYears
  - Movies
  - MusicAddons
  - MusicFiles
  - MusicPlaylists
  - MusicRoot
  - MusicVideoAlbums
  - MusicVideoArtists
  - MusicVideoDirectors
  - MusicVideoGenres
  - MusicVideoStudios
  - MusicVideoTitles
  - MusicVideoYears
  - MusicVideos
  - ProgramAddons
  - RecentlyAddedAlbums
  - RecentlyAddedEpisodes
  - RecentlyAddedMovies
  - RecentlyAddedMusicVideos
  - RecentlyPlayedAlbums
  - Settings
  - Singles
  - Song
  - SubTitles
  - Top100
  - Top100Albums
  - Top100Songs
  - TvShowActors
  - TvShowGenres
  - TvShowStudios
  - TvShowTitles
  - TvShowYears
  - TvShows
  - VideoAddons
  - VideoFiles
  - VideoPlaylists
  - VideoRoot
  - Years
- mute [<0|1>] - 1 for mute; 0 for unmute; by default the mute status will be toggled
- volume <n> - sets the volume to <n>. <n> must be a number between 0 and 100
- volumeDown <n> - volume down
- volumeUp <n> - volume up
- quit - closes Kodi
- off - depending on the value of the attribute "offMode" Kodi will be closed (see quit) or the system will be shut down, put into hibernation or stand by. Default is quit.

System related commands:

- eject - will eject the optical drive
- shutdown - the Kodi host will be shut down
- suspend - the Kodi host will be put into stand by
- hibernate - the Kodi host will be put into hibernation
- reboot - the Kodi host will be rebooted
- connect - try to connect to the Kodi host immediately

Messaging

To show messages on Kodi (little message PopUp at the bottom right egde of the screen) you can use the following commands:
`set <KODI_device> msg <title> <msg> [<duration>] [<icon>]`
The default duration of a message is 5000 (5 seconds). The minimum duration is 1500 (1.5 seconds). By default no icon is shown. Kodi provides three different icon: error, info and warning. You can also use an uri to define an icon. Please enclose title and/or message into quotes (" or ') if it consists of multiple words.

Generated Readings/Events:

- audiolibrary - Possible values: cleanfinished, cleanstarted, remove, scanfinished, scanstarted, update
- currentAlbum - album of the current song/musicvideo
- currentArtist - artist of the current song/musicvideo
- currentMedia - file/URL of the media item being played
- currentTitle - title of the current media item
- currentTrack - track of the current song/musicvideo
- episode - episode number
- episodeid - id of the episode in the video library
- fullscreen - indicates if Kodi runs in fullscreen mode (on/off)
- label - label of the current media item
- movieid - id of the movie in the video library
- musicvideoid - id of the musicvideo in the video library
- mute - indicates if Kodi is muted (on/off)
- name - software name (e.g. Kodi)
- originaltitle - original title of the movie being played
- partymode - indicates if Kodi runs in party mode (on/off) (not available for Plex)
- playlist - Possible values: add, clear, remove
- playStatus - Indicates the player status: playing, paused, stopped
- repeat - current repeat mode (one/all/off)
- season - season of the current episode
- showtitle - title of the show being played
- shuffle - indicates if the playback is shuffled (on/off)
- skin - current skin of Kodi
- songid - id of the song in the music library
- system - Possible values: lowbattery, quit, restart, sleep, wake
- time - current position in the playing media item (only updated on play/pause)
- totaltime - total run time of the current media item
- type - type of the media item. Possible values: episode, movie, song, musicvideo, picture, unknown
- version - version of Kodi
- videolibrary - Possible values: cleanfinished, cleanstarted, remove, scanfinished, scanstarted, update
- volume - value between 0 and 100 stating the current volume setting
- year - year of the movie being played
- 3dfile - is a 3D movie according to filename
- sd_<type><n>_<reading> - stream details of the current medium. type can be video, audio or subtitle, n is the stream index (a stream can have multiple audio/video streams)

Remarks on the events

The event playStatus = playing indicates a playback of a media item. Depending on the event type different events are generated:

- type = song generated events are: album, artist, file, title and track
- type = musicvideo generated events are: album, artist, file and title
- type = episode generated events are: episode, file, season, showtitle, and title
- type = movie generated events are: originaltitle, file, title, and year
- type = picture generated events are: file
- type = unknown generated events are: file

Attributes

- compatibilityMode
  This module can also be used to control Plex, since the JSON Api is mostly the same, but there are some differences. If you want to control Plex set the attribute compatibilityMode to plex.
- offMode
  Declares what should be down if the off command is executed. Possible values are quit (closes Kodi), hibernate (puts system into hibernation), suspend (puts system into stand by), and shutdown (shuts down the system). Default value is quit
- fork
  If Kodi does not run all the time it used to be the case that FHEM blocks because it cannot reach Kodi (only happened if TCP was used). If you encounter problems like FHEM not responding for a few seconds then you should set `attr <KODI_device> fork enable` which will move the search for Kodi into a separate process.
- updateInterval
  The interval which is used to check if Kodi is still alive (by sending a JSON ping) and also it is used to update current player item.
- disable
  Disables the device. All connections will be closed immediately.

### Kopp Free Control protocol

Please take into account: this protocol is under construction. Commands may change
The Kopp Free Control protocol is used by Kopp receivers/actuators and senders. This module is able to send commands to Kopp actuators and receive commands from Kopp transmitters. Currently supports devices: dimmers, switches and blinds. The communication is done via a CUL or compatible device (e.g. CCD...). This devices must be defined before using this protocol.
Assign the Kopp Free Control protocol to a CUL or compatible device

`define CUL_0 CUL /dev/ttyAMA0@38400 1234`
`attr CUL_0 rfmode KOPP_FC`
This attribute ("rfmode KOPP_FC") assigns the Kopp protocol to device CUL_0
You may not assign/use a second protocol on this device

Define

`define <name> KOPP_FC <Keycode> <Transmittercode1> <Transmittercode2> [<Keycode2>] [<Keycode3>]`
- `<name>`
name is the identifier (name) you plan to assign to your specific device (actuator) as done for any other FHEM device
- `<Keycode>`
Keycode is a 2 digit hex code (1Byte) which reflects the transmitters key
- `<Transmittercode1>`
Transmittercode1 is a 4 digit hex code. This code is specific for the transmitter itself.
- `<Transmittercode2>`
Transmittercode2 is a 2 digit hex code and also specific for the transmitter, but I didn't see any difference while modifying this code. (seems this code don't matter the receiver).
Both codes (Transmittercode1/2) are also used to pair the transmitter with the receivers (remote switch, dimmer, blind..)
- `[<Keycode2>]`
Keycode2 is an opional 2 digit hex code (1Byte) which reflects a second transmitters key
- `[<Keycode3>]`
Keycode3 is an opional 2 digit hex code (1Byte) which reflects a third transmitters key
Some receivers like dimmers can be paired with two addional keys, which allow to switch the dimmer directly on or off. That means FHEM will always know the current state, which is not the case in one key mode (toggling between on and off)
Pairing is done by setting the receiver in programming mode by pressing the program button at the receiver
(small buttom, typically inside a hole).
Once the receiver is in programming mode send a command (or two, see dimmer above) from within FHEM to complete the pairing. For more details take a look to the data sheet of the corresponding receiver type.
You are now able to control the receiver from FHEM, the receiver handles FHEM just linke another remote control.

Set

`set <name> <value>`
- `<value>`
value is one of:

`on`
`off`
`dimm`
`stop`

    Examples:
        set Dimmer on          # will toggle dimmer device on/off for 1Key remote control,
                                 will switch on for 3 key remote control
        set Dimmer off         # will switch dimmer device off (3 key remote control)
        set Dimmer dimm        # will start dimming process
        set Dimmer stop        # will stop dimming process

Attributes

`attr <name> model <value>`
- `<value>`
value is one of:

`Switch_8080_01`
`Switch_8080_01_2Key`
`Blind_8080_02`
`Timer_8080_04`
`Dimm_8011_00`
`Dimm_8011_00_3Key`

Examples

FHEM Config for Dimmer via 1 Key remote control:

`define Dimmer KOPP_FC 65 FA5E 02`
`attr Dimmer IODev CUL_0`
`attr Dimmer devStateIcon OnOff:toggle:dimm dimm:dim50%:stop stop:on:dimm off:toggle:dimm`
`attr Dimmer eventMap on:OnOff dimm:dimm stop:stop`
`attr Dimmer group TestGroup`
`attr Dimmer model Dimm_8011_00`
`attr Dimmer room TestRoom`
`attr Dimmer webCmd OnOff:dimm:stop`

FHEM Config for Dimmer via 3 Key remote control:

`define SDimmer KOPP_FC 65 FA5E 02 55 75`
`attr SDimmer IODev CUL_0`
`attr SDimmer devStateIcon dimm:dim50%:stop stop:on:off on:on:off off:off:on`
`attr SDimmer group TestGroup`
`attr SDimmer icon light_pendant_light`
`attr SDimmer model Dimm_8011_00_3Key`
`attr SDimmer room TestRoom`
`attr SDimmer webCmd on:dimm:stop:off`

Additional Information you can find in corresponding FHEM Wiki

- Kopp Allgemein

### KOSTALPIKO

Define
`define <name> KOSTALPIKO <ip-address> <user> <password>`
The module reads the current values from web page of a Kostal Piko inverter.
It can also be used, to capture the values of global radiation, UV-index and sunshine duration
from a special web-site (proplanta) regardless of the existence of the inverter.
Parameters:

- <ip-address> - the ip address of the inverter
- <user> - the login-user for the inverter's web page
- <password> - the login-password for the inverter's web page

Example:
`define Kostal KOSTALPIKO 192.168.2.4 pvserver pvwr`
Set-Commands
`set <name> captureGlobalRadiation`
The values for global radiation, UV-index and sunshine duration are immediately polled.
`set <name> captureKostalData`
All values of the inverter are immediately polled.
Attributes

- readingFnAttributes
- BAEnable - if 1, data from ../BA.fhtml site is captured
- GR.Interval - poll interval for global radiation in seconds
- GR.Link - regionalised link the to the proplanta web page (global radiation, UV-index and sunshine duration)
  (see Wiki for further information)
- delay - poll interval for the values of the inverter in seconds
- delayCounter - delay counter for poll of invert's values beside AC.Power;
  needed for fast acquisition scenarios to limit the log-output.
- disable - if disable=1, the poll of inverter's values is disabled,
  ut not the the poll of proplanta-values

Generated Readings/Events

- AC.Power - the current power, captured only if the internal delayCounter = 0
- AC.Power.Fast - the current power, on each poll cycle; used for fast acquisition scenarios
- Daily.Energie - the current procduced energie of the day
- Daily.Energie.Last - the value of daily energy at 23:00 clock
- Global.Radiation - the value of global radiation (proplanta);useful for determing the expected energy amount of the day
- ModeNum - the current processing state of the inverter (1=off 2=idle 3=active)
- Mode - the german term for the current ModeNum
- Total.Energy - the total produced energie
- generator.1.current - the electrical current at string 1
- generator.2.current - the electrical current at string 2
- generator.3.current - the electrical current at string 3
- generator.1.voltage - the voltage at string 1
- generator.2.voltage - the voltage at string 2
- generator.3.voltage - the voltage at string 3
- output.1.voltage - the voltage at output 1
- output.2.voltage - the voltage at output 2
- output.3.voltage - the voltage at output 3
- output.1.power - the power at output 1
- output.2.power - the power at output 2
- output.3.power - the power at output 3
- sensor.1 - the voltage at analog input 1
- sensor.2 - the voltage at analog input 2
- sensor.3 - the voltage at analog input 3
- sensor.4 - the voltage at analog input 4
- UV.Index - the UV Index (proplanta)
- sunshine.duration - the sunshine duration (proplanta)

Additional Readings/Events, if BAEnable=1

- Battery.CycleCount - count of charge cycles
- Battery.StateOfCharge - State of charge for the battery in percent
- Battery.Voltage - the voltage of the battery
- Battery.ChargeCurrent - the charge current of the battery
- Battery.Temperature - the temperature of the battery
- Power.Solar - the sum of the power produced by the solarinverter
- Power.Battery - the power drawn from the battery
- Power.Net - the power drawn from the main
- Power.Phase1 - the power used on phase L1
- Power.Phase2 - the power used on phase L2
- Power.Phase3 - the power used on phase L3

Additional information

- Discussion in FHEM forum
- Information in FHEM Wiki

### KS300

Fhem can receive the KS300 or KS555 radio messages through the FHZ, WS300 or CUL, so one of them must be defined first.
This module services messages received by the FHZ or CUL.
Define

`define <name> KS300 <housecode> [ml/raincounter [wind-factor]]`
`<housecode>` is a four digit hex number, it must be specified foir historic reasons, and it is ignored. The ml/raincounter defaults to 255 ml, and it must be specified if you wish to set the wind factor, which defaults to 1.0.
Examples:

`define ks1 KS300 1234`

Set

N/A

Get

N/A

Attributes

- ignore
- IODev
- eventMap
- do_not_notify
- showtime
- model (ks300)
- rainadjustment
  If this attribute is set, fhem automatically considers rain counter resets after a battery change and random counter switches as experienced by some users. Default is 0 (off).

### KeyValueProtocol

A generic module to receive key-value-pairs from an IODevice like JeeLink.
The data source can send any key/value pairs, which will get converted into readings.
The protocol that the sketch must send is: OK VALUES Key1=Value1,Key2=Value2, ...
Define

`define <name> KeyValueProtocol <Type> <ID>`

Set

Get

Attributes

- Dictionary
  The Dictionary attribute can optionally be used to translate the Keys.
  The format is: ReceivedKey1=NewKey1,ReceivedKey2=NewKey2, ...
  The Sketch can then send short Keys, which will get translated to long names.
  Example: attr myKVP Dictionary T=Temperature,H=Humidity
  If the sketch then sends: OK VALUES T=12,H=70
  you will get the readings Temperature and Humidity with the Values 12 and 70

Readings

Depending on the received data

### LGTV

Define

`define <name> LGTV`
This module is expected to work with xxLG7000 as it's IODev. With LGTV and a compatible hardware module (currently, there's only xxLG7000), you are able to power your TV set on and off, query it's power state, select the input (AV, RGB, Composites, analogue TV, DVB-T, HDMI) or mute/unmute the volume.
Defining a LGTV device will schedule an internal task, which periodically reads the status of the TV set (power state; if power is on, query the selected input) and triggers notify/filelog commands.
Example:

`define 47LG7000 LGTV`
`attr 47LG7000 IODev myLG7k`

Set

`set <name> <what> <value>`
Currently, the following commands are defined; not all may be available on a given TV set. An error messages should be recorded if e. g. the input in question is not usable.

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

Get

`get <name> <what>`
Currently, the following commands are defined; not all may be available on a given TV set. An error messages should be recorded if e. g. the input in question is not usable.

    power
    input
    audio

Attributes

- dummy
- loglevel

Implementator's note

The commands listed above are send 1:1 to the underlying IODev (e. g. xxLG7000); that IODev is responsible for translation into whatever means to invoke the function on the TV. It is my hope that other's will adopt this idea and write compatible low level drivers for other TV sets, to make this module (even ;)) more useful.

### LGTV_IP12

This module controls LG SmartTV's which were released between 2012 - 2014 via network connection. You are able to switch query it's power state, control the TV channels, open and close apps and send all remote control commands.
For a list of supported models see the compatibility list for LG TV Remote smartphone app.
Define

`define <name> LGTV_IP12 <ip-address> [<status_interval>]
define <name> LGTV_IP12 <ip-address> [<off_status_interval>] [<on_status_interval>]`
Defining a LGTV_IP12 device will schedule an internal task (interval can be set with optional parameter <status_interval> in seconds, if not set, the value is 30 seconds), which periodically reads the status of the TV (power state, current channel, input, ...) and triggers notify/FileLog commands.
Different status update intervals depending on the power state can be given also. If two intervals are given to the define statement, the first interval statement represents the status update interval in seconds in case the device is off. The second interval statement is used when the device is on. Example:

`define TV LGTV_IP12 192.168.0.10
# With custom status interval of 60 seconds
define TV LGTV_IP12 192.168.0.10 60
# With custom "off"-interval of 60 seconds and "on"-interval of 10 seconds
define TV LGTV_IP12 192.168.0.10 60 10`

Set

`set <name> <command> [<parameter>]`
Currently, the following commands are defined.

- channel - set the current channel
- channelUp - switches to next channel
- channelDown - switches to previous channel
- removePairing - deletes the pairing with the device
- showPairCode - requests the TV to display the pair code on the TV screen. This pair code must be set in the attribute pairingcode
- startApp - start a installed app on the TV
- stopApp - stops a running app on the TV
- statusRequest - requests the current status of the device
- remoteControl up,down,... - sends remote control commands

Get

`get <name> <reading>`
Currently, the get command only returns the reading values. For a specific list of possible values, see section "Generated Readings/Events".

Attributes

- do_not_notify
- readingFnAttributes
- disable
Optional attribute to disable the internal cyclic status update of the TV. Manual status updates via statusRequest command is still possible.
Possible values: 0 => perform cyclic status update, 1 => don't perform cyclic status updates.
- disabledForIntervals HH:MM-HH:MM HH:MM-HH-MM...
Optional attribute to disable the internal cyclic status update of the TV 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 cyclic update will be disabled. Instead of HH:MM you can also specify HH or HH:MM:SS.
To specify an interval spawning midnight, you have to specify two intervals, e.g.:

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

Default Value is empty (no intervals defined, cyclic update is always active)
- request-timeout
Optional attribute change the response timeout in seconds for all queries to the TV.
Possible values: 1-5 seconds. Default value is 4 seconds.
- pairingcode
This attribute contains the pairing code to authenticate FHEM as trusted controller. The pairing code can be displayed via set command `showPairCode`

Generated Readings/Events:

- 3D - The status of 3D playback (can be "true" or "false")
- channel - The number of the current channel
- channelName - The name of the current channel
- currentProgram - The name of the running program of the current channel
- input - The current input source (e.g. Antenna, Sattelite, HDMI1, ...)
- inputLabel - The user defined name of the current input source
- mute - Reports the current mute state (can be "on" or "off")
- power - The power status (can be "on" or "off")
- volume - Reports the volume state.

### LIGHTIFY

Module to integrate a OSRAM LIGHTIFY gateway into FHEM;.
The actual LIGHTIFY lights are defined as HUEDevice devices.
All newly found devices and groups are autocreated at startup and added to the room LIGHTIFY.
Notes:

- Autocreate only works for the first gateway. Devices on other gateways have to be manualy defined.

Define

`define <name> LIGHTIFY <host>`
Defines a LIGHTIFY gateway device with address <host>.
Examples:

`define gateway LIGHTIFY 10.0.1.100`

Get

Set

- on
- off
- goToScene <sceneId>
- setSoftOn <addr> <transitiontime>
- setSoftOff <addr> <transitiontime>
- reconnect
  Closes and reopens the connection to the gateway.
- statusRequest
  Update light status.

Attributes

- disable
- disabledForIntervals

### LINDY_HDMI_SWITCH

Note: this module needs the Net::Telnet module.
Define

`define <name> LINDY_HDMI_SWITCH <ip-address> <port>`
Defines an Lindy 4:2 HDMI Switch serial connected to a transparent ethernet to serial adapter via the ip address of the adapter. Lindy partnumber: 38054
Examples:

`define livingroom.hdmi LINDY_HDMI_SWITCH 192.168.1.64 4999`

Set

`set <name> <value>`
where `value` is one of:

    	11
    	12
    	13
    	14
    	21
    	22
    	23
    	24

First digit is the output port, second digit is the input port. Example:

`set livingroom.hdmi 12`

### LIRC

Generate FHEM-events when an LIRC device receives infrared signals.
Note: this module needs the Lirc::Client perl module.
Define

define <name> LIRC <lircrc_file>
Example:

define Lirc LIRC /etc/lirc/lircrc

Note: In the lirc configuration file you have to define each possible event. If you have this configuration

        begin
          prog = fhem
          button = pwr
          config = IrPower
        end

and you press the pwr button the IrPower toggle event occures at fhem.

        define IrPower01 notify Lirc:IrPower set lamp toggle

turns the lamp on and off. If you want a faster reaction to keypresses you have to change the defaultvalue of readytimeout from 5 seconds to e.g. 1 second in fhem.pl

Set

N/A

Get

N/A

Attributes

### LUXTRONIK2

Luxtronik 2.0 is a heating controller used in Alpha Innotec, Siemens Novelan (WPR NET) and Wolf Heiztechnik (BWL/BWS) heat pumps.
It has a built-in ethernet port, so it can be directly integrated into a local area network (LAN).
The modul is reported to work with firmware: V1.51, V1.54C, V1.60, V1.64, V1.69, V1.70, V1.73, V1.77.
More Info on the particular page of FHEM-Wiki (in German).
Define

`define <name> LUXTRONIK2 <IP-address[:Port]> [poll-interval]`
If the pool interval is omitted, it is set to 300 (seconds). Smallest possible value is 30.
Usually, the port needs not to be defined.
Example: `define Heizung LUXTRONIK2 192.168.0.12 600`

Set

A firmware check assures before each set operation that a heat pump with untested firmware is not damaged accidently.
- `activeTariff < 0 - 9 >`
  Allows the separate measurement of the consumption (doStatistics = 1) within different tariffs.
  This value must be set at the correct point of time in accordance to the existing or planned tariff by the FHEM command "at".
  0 = without separate tariffs
- `INTERVAL <polling interval>`
  Polling interval in seconds
- `hotWaterTemperatureTarget <temperature>`
  Target temperature of domestic hot water boiler in °C
- `hotWaterCircPumpDeaerate <on | off>`
  Switches the external circulation pump for the hot water on or off. The circulation prevents a cool down of the hot water in the pipes but increases the heat consumption drastically.
  NOTE! It uses the deaerate function of the controller. So, the pump alternates always 5 minutes on and 5 minutes off.
- `opModeHotWater <Mode>`
  Operating Mode of domestic hot water boiler (Auto | Party | Off)
- `resetStatistics <statReadings>`
  Deletes the selected statistic values all, statBoilerGradientCoolDownMin, statAmbientTemp..., statElectricity..., statHours..., statHeatQ...
- `returnTemperatureHyst <Temperature>`
  Hysteresis of the returnTemperatureTarget of the heating controller . 0.5 K till 3 K. Adjustable in 0.1 steps.
- `returnTemperatureSetBack <Temperature>`
  Decreasing or increasing of the returnTemperatureTarget by -5 K till + 5 K
- `statusRequest`
  Update device information
- `synchClockHeatPump`
  Synchronizes controller clock with FHEM time. !! This change is lost in case of controller power off!!

Get

No get implemented yet ...

Attributes

- `allowSetParameter < 0 | 1 >`
  The parameters of the heat pump controller can only be changed if this attribut is set to 1.
- `autoSynchClock <delay>`
  Corrects the clock of the heatpump automatically if a certain delay (10 s - 600 s) against the FHEM time is exeeded. Does a firmware check before.
  (A 'delayDeviceTimeCalc' <= 2 s can be caused by the internal calculation interval of the heat pump controller.)
- `compressor2ElectricalPowerWatt`
  Electrical power of the 2nd compressor to calculated the COP and estimate electrical consumption (calculations not implemented yet)
- `doStatistics < 0 | 1 >`
  Calculates statistic values: statBoilerGradientHeatUp, statBoilerGradientCoolDown, statBoilerGradientCoolDownMin (boiler heat loss)
  Builds daily, monthly and yearly statistics for certain readings (average/min/max or cumulated values).
  Logging and visualisation of the statistic should be done with readings of type 'statReadingName Last'.
- `heatPumpElectricalPowerWatt`
  Electrical power of the heat pump by a flow temperature of 35°C to calculated coefficency factor and estimate electrical consumption
- `heatPumpElectricalPowerFactor`
  Change of electrical power consumption per 1 K flow temperature differenz to 35°C (e.g. 2% per 1 K = 0,02)
- `heatRodElectricalPowerWatt`
  Electrical power of the heat rods (2nd heat source) to estimate electrical consumption
- `ignoreFirmwareCheck < 0 | 1 >`
  A firmware check assures before each set operation that a heatpump controller with untested firmware is not damaged accidently.
  If this attribute is set to 1, the firmware check is ignored and new firmware can be tested for compatibility.
- `statusHTML`
  If set, a HTML-formatted reading named "floorplanHTML" is created. It can be used with the FLOORPLAN module.
  Currently, if the value of this attribute is not NULL, the corresponding reading consists of the current status of the heat pump and the temperature of the water.
- readingFnAttributes

### LaCrosse

FHEM module for LaCrosse Temperature and Humidity sensors and weather stations like WS 1600 (TX22 sensor).
It can be integrated in to FHEM via a JeeLink as the IODevice.
The JeeNode sketch required for this module can be found in .../contrib/36_LaCrosse-pcaSerial.zip.
Define

`define <name> LaCrosse <addr> [corr1...corr2]`
addr is a 2 digit hex number to identify the LaCrosse device.
corr1..corr2 are up to 2 numerical correction factors (corr1 for the temperature and corr2 for the humidity), which will be added to the respective value to calibrate the device.
Note: devices are autocreated only if LaCrossePairForSec is active for the JeeLink IODevice device.

Set

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

Get

Readings

- battery[]
  ok or low
- temperature (°C)
  Notice: see the filterThreshold attribute.
- humidity (%rH)
- Wind speed (m/s), gust (m/s) and direction (degree)
- Rain (mm)

Attributes

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

Logging and autocreate

- If autocreate is not active (not defined or disabled) and LaCrosse is not contained in the ignoreTypes attribute of autocreate then the Unknown device xx, please define it messages will be logged with loglevel 3. In all other cases they will be logged with loglevel 4.
- The autocreateThreshold attribute of the autocreate module (see autocreate) is respected. The default is 2:120, means, that autocreate will create a device for a sensor only, if the sensor was received at least two times within two minutes.

### LaCrosseGateway

For more information about the LaCrosseGateway see here: FHEM wiki
Define

`define <name> LaCrosseGateway <device>`
USB-connected devices:

<device> specifies the serial port to communicate with the LaCrosseGateway. The name of the serial-device depends on your distribution, under linux it is something like /dev/ttyACM0 or /dev/ttyUSB0.

Network-connected devices:

<device> specifies the network device
Normally this is the IP-address and the port in the form ip:port
Example: 192.168.1.100:81
You must define the port number on the setup page of the LaCrosseGateway and use the same number here.
The default is 81

Set

- raw <data>
  send <data> to the LaCrosseGateway. The possible command can be found in the wiki.
- connect
  tries to (re-)connect to the LaCrosseGateway. It does not reset the LaCrosseGateway but only try to get a connection to it.
- reboot
  Reboots the ESP8266. Works only if we are connected (state is opened or initialized)
- LaCrossePairForSec <sec> [ignore_battery]
  enable autocreate of new LaCrosse sensors for <sec> seconds. If ignore_battery is not given only sensors sending the 'new battery' flag will be created.
- flash
  The LaCrosseGateway needs the right firmware to be able to receive and deliver the sensor data to fhem.
  This provides a way to flash it directly from FHEM.
- nextionUpload
  Requires LaCrosseGateway V1.24 or newer.
  Sends a Nextion firmware file (.tft) to the LaCrosseGateway. The LaCrosseGateway then distributes it to a connected Nextion display.
  You can define the .tft file that shall be uploaded in the tftFile attribute. If this attribute does not exists, it will try to use FHEM/firmware/nextion.tft

Get

---

Attributes

- Clients
  The received data gets distributed to a client (e.g. LaCrosse, EMT7110, ...) 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 LaCrosseGateway module, you must add it to the Clients attribute.
- MatchList
  Can be set to a perl expression that returns a hash that is used as the MatchList
- initCommands
  Space separated list of commands to send for device initialization.
- timeout
  format: <timeout>
  Asks the LaCrosseGateway every timeout seconds if it is still alive. If there is no response it reconnects to the LaCrosseGateway.
  Can be combined with the watchdog attribute. If the watchdog attribute is set, the LaCrosseGateway also will check if it gets a request within watchdog seconds and if not, it will reboot. watchdog must be longer than timeout and does only work in combination with timeout.
  Both should not be too short because the LaCrosseGateway needs enough time to boot before the next check.
  Good values are: timeout 60 and watchdog 300
  This mode needs LaCrosseGateway V1.24 or newer.
  Old version (still working):
  format: <timeout, checkInterval>
  Checks every 'checkInterval' seconds if the last data reception is longer than 'timeout' seconds ago.
  If this is the case, a new connect will be tried.
- watchdog
  see timeout attribute.
- disable
  if disabled, it does not try to connect and does not dispatch data
- kvp
  defines how the incoming KVP-data of the LaCrosseGateway is handled
  dispatch: (default) dispatch it to a KVP device
  readings: create readings (e.g. RSSI, ...) in this device
  both: dispatch and create readings
- ownSensors
  defines how the incoming data of the internal LaCrosseGateway sensors is handled
  dispatch: (default) dispatch it to a LaCrosse device
  readings: create readings (e.g. temperature, humidity, ...) in this device
  both: dispatch and create readings
- mode
  USB, WiFi or Cable
  Depending on how the LaCrosseGateway is connected, it must be handled differently (init, ...)
- tftFile
  defines the .tft file that shall be used by the Nextion firmware upload (set nextionUpload)

### Level

FHEM module for Level.
It can be integrated in to FHEM via a JeeLink as the IODevice.
The JeeNode sketch required for this module can be found in .../contrib/36_LaCrosse-LaCrosseITPlusReader.zip. It must be at least version 10.0c
For more information see: http://forum.fhem.de/index.php/topic,23217.msg165163.html#msg165163
Define

`define <name> Level <addr>`
addr is a 1 digit hex number (0 .. F) to identify the Level device.

Readings

- liters
  Calculated liters based on distanceToBottom, distance and litersPerCm
- temperature
  Measured temperature
- voltage
  Measured battery voltage
- distance
  Measured distance from the sensor to the fluid
- level
  Calculated level based on the distanceToBottom attribute

Attributes

- distanceToBottom
  Distance from the ultra sonic sensor to the bottom of the tank
- litersPerCm
  Liters for each cm level

### LightScene

Allows to store the state of a group of lights and other devices and recall it later. Multiple states for one group can be stored.
Define

`define <name> LightScene [<dev1>] [<dev2>] [<dev3>] ...`
Examples:

`define light_group LightScene Lampe1 Lampe2 Dimmer1`
`define kino_group LightScene LampeDecke LampeFernseher Fernseher Verstaerker`
`define Wohnzimmer LightScene Leinwand Beamer TV Leselampe Deckenlampe`

The device detail view will show an html overview of the current state of all included devices and all configured scenes with the device states for each. The column heading with the device names is clickable to go to detail view of this device. The first row that displays the current device state is clickable and should react like a click on the device icon in a room overview would. this can be used to interactively configure a new scene and save it with the command menu of the detail view. The first column of the table with the scene names ic clickable to activate the scene.
A weblink with a scene overview that can be included in any room or a floorplan can be created with:

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

Set

- save <scene_name>
  save current state for alle devices in this LightScene to <scene_name>
- scene <scene_name>
  shows scene <scene_name> - all devices are switched to the previously saved state
- nextScene [nowrap]
  activates the next scene in alphabetical order after the current scene or the first if no current scene is set.
- previousScene [nowrap]
  activates the previous scene in alphabetical order before the current scene or the last if no current scene is set.
- set <scene_name> <device> [<cmd>]
  set the saved state of <device> in <scene_name> to <cmd>
- setcmd <scene_name> <device> [<cmd>]
  set command to be executed for <device> in <scene_name> to <cmd>. <cmd> can be any commandline that fhem understands including multiple commands separated by ;;
  - set kino_group setcmd allOff LampeDecke sleep 30 ;; set LampeDecke off
  - set light_group setcmd test Lampe1 sleep 10 ;; set Lampe1 on ;; sleep 5 ;; set Lampe1 off
- remove <scene_name>
  remove <scene_name> from list of saved scenes
- rename <scene_old_name> <scene_new_name>
  rename <scene_old_name> to <scene_new_name>

Get

- scenes
- scene <scene_name>

Attributes

- async_delay
  If this attribute is defined, unfiltered set commands will not be executed in the clients immediately. Instead, they are added to a queue to be executed later. The set command returns immediately, whereas the clients will be set timer-driven, one at a time. The delay between two timercalls is given by the value of async_delay (in seconds) and may be 0 for fastest possible execution.
- lightSceneParamsToSave
  this attribute can be set on the devices to be included in a scene. it is set to a comma separated list of readings that will be saved. multiple readings separated by : are collated in to a single set command (this has to be supported by the device). each reading can have a perl expression appended with '@' that will be used to alter the $value used for the set command. this can for example be used to strip a trailing % from a dimmer state. this perl expression must not contain spaces,colons or commas.
  in addition to reading names the list can also contain expressions of the form `abc -> xyz` or `get cba -> set uvw` to map reading abc to set xyz or get cba to set uvw. the list can be given as a string or as a perl expression enclosed in {} that returns this string.
  `attr myReceiver lightSceneParamsToSave volume,channel`
  `attr myHueDevice lightSceneParamsToSave {(Value($DEVICE) eq "off")?"state":"bri : xy"}`
`attr myDimmer lightSceneParamsToSave state@{if($value=~m/(\d+)/){$1}else{$value}}`
- lightSceneRestoreOnlyIfChanged
  this attribute can be set on the lightscene and/or on the individual devices included in a scene. the device settings have precedence over the scene setting.
  1 -> for each device do nothing if current device state is the same as the saved state
  0 -> always set the state even if the current state is the same as the saved state. this is the default
- followDevices
  the LightScene tries to follow the switching state of the devices set its state to the name of the scene that matches.
  1 -> if no match is found state will be unchanged and a nomatch event will be triggered.
  2 -> if no match is found state will be set to unknown. depending on the scene and devices state can toggle multiple times. use a watchdog if you want to handle this.
- showDeviceCurrentState
  show the current state of member devices in weblink
- switchingOrder
  space separated list of <scene>:<deviceList> items that will give a per scene order in which the devices should be switched.
  the devices from <deviceList> will come before all other devices of this LightScene; if the first character of the <deviceList> ist a ! the devices from the list will come after all other devices from this lightScene.
  <scene> and each element of <deviceList> are treated as a regex.
  Example: To switch a master power outlet before every other device at power on and after every device on power off:
  `define media LightScene TV,DVD,Amplifier,masterPower
  attr media switchingOrder .*On:masterPower,.* allOff:!.*,masterPower`
- readingFnAttributes

### M232

Define

`define <name> M232 <m232-device>`
Define a M232 device. You can attach as many M232 devices as you like. A M232 device provides 6 analog inputs (voltage 0..5V with 10 bit resolution) and 8 bidirectional digital ports. The eighth digital port can be used as a 16 bit counter (maximum frequency 3kHz). The M232 device needs to be connected to a 25pin sub-d RS232 serial port. A USB-to-serial converter works fine if no serial port is available.
Examples:

`define m232 M232 /dev/ttyUSB2`

Set

`set <name> stop`
Stops the counter.
`set <name> start`
Resets the counter to zero and starts it.
`set <name> octet <value>`
Sets the state of all digital ports at once, value is 0..255.
`set <name> io0..io7 0|1`
Turns digital port 0..7 off or on.

Get

`get <name> [an0..an5]`
Gets the reading of analog input 0..5 in volts.
`get <name> [io0..io7]`
Gets the state of digital ports 0..7, result is 0 or 1.
`get <name> octet`
Gets the state of all digital ports at once, result is 0..255.
`get <name> counter`
Gets the number of ticks of the counter since the last reset. The counter wraps around from 65,535 to 0 and then stops. See M232Counter for how we care about this.

Attributes

- model (m232)

### M232Counter

Define

`define <name> M232Counter [unit [factor [deltaunit [deltafactor]]]]`
Define at most one M232Counter for a M232 device. Defining a M232Counter will schedule an internal task, which periodically reads the status of the counter, and triggers notify/filelog commands. `unit` is the unit name, `factor` is used to calculate the reading of the counter from the number of ticks. `deltaunit` is the unit name of the counter differential per second, `deltafactor` is used to calculate the counter differential per second from the number of ticks per second.
Default values:

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

Note: the parameters in square brackets are optional. If you wish to specify an optional parameter, all preceding parameters must be specified as well.
Examples:

`define counter M232Counter turns`
`define counter M232Counter kWh 0.0008 kW 2.88` (one tick equals 1/1250th kWh)

Do not forget to start the counter (with `set .. start` for M232) or to start the counter and set the reading to a specified value (with `set ... value` for M232Counter).
To avoid issues with the tick count reaching the end point, the device's internal counter is automatically reset to 0 when the tick count is 64,000 or above and the reading basis is adjusted accordingly.

Set

`set <name> value <value>`
Sets the reading of the counter to the given value. The counter is reset and started and the offset is adjusted to value/unit.
`set <name> interval <interval>`
Sets the status polling interval in seconds to the given value. The default is 60 seconds.

Get

`get <name> status`
Gets the reading of the counter multiplied by the factor from the `define` statement. Wraparounds of the counter are accounted for by an offset (see reading `basis` in the output of the `list` statement for the device).

Attributes

- dummy
- model (M232Counter)

### M232Voltage

Define

`define <name> M232Voltage [an0..an5] [unit [factor]]`
Define as many M232Voltages as you like for a M232 device. Defining a M232Voltage will schedule an internal task, which reads the status of the analog input every minute, and triggers notify/filelog commands. `unit` is the unit name, `factor` is used to calibrate the reading of the analog input.
Note: the unit defaults to the string "volts", but it must be specified if you wish to set the factor, which defaults to 1.0.
Example:

`define volt M232Voltage an0`
`define brightness M232Voltage an5 lx 200.0`

Set

N/A

Get

`get <name> status`

Attributes

- dummy
- model (M232Voltage)

### MAX

Devices from the eQ-3 MAX! group.
When heating thermostats show a temperature of zero degrees, they didn't yet send any data to the cube. You can force the device to send data to the cube by physically setting a temperature directly at the device (not through fhem).
Define

`define <name> MAX <type> <addr>`
Define an MAX device of type <type> and rf address <addr>. The <type> is one of HeatingThermostat, HeatingThermostatPlus, WallMountedThermostat, ShutterContact, PushButton. The <addr> is a 6 digit hex number. You should never need to specify this by yourself, the autocreate module will do it for you.
It's advisable to set event-on-change-reading, like `attr MAX_123456 event-on-change-reading .*` because the polling mechanism will otherwise create events every 10 seconds.
Example:

`define switch1 MAX PushButton ffc545`

Set

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

Get

N/A

Attributes

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

Generated events:

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

### MAXLAN

The MAXLAN is the fhem module for the eQ-3 MAX! Cube LAN Gateway.
The fhem module makes the MAX! "bus" accessible to fhem, automatically detecting paired MAX! devices. It also represents properties of the MAX! Cube. The other devices are handled by the MAX module, which uses this module as its backend.
Define

`define <name> MAXLAN <ip-address>[:port] [<pollintervall> [ondemand]]`
port is 62910 by default. (If your Cube listens on port 80, you have to update the firmware with the official MAX! software). If the ip-address is called none, then no device will be opened, so you can experiment without hardware attached.
The optional parameter <pollintervall> defines the time in seconds between each polling of data from the cube.
You may provide the option `ondemand` forcing the MAXLAN module to tear-down the connection as often as possible thus making the cube usable by other applications or the web portal.

Set

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

Get

N/A

Attributes

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

### MEDIAPORTAL

Connects to a running MediaPortal instance via the WifiRemote plugin

#### Example

`define wohnzimmer_Mediaportal MEDIAPORTAL 192.168.0.47:8017`

#### Define

`define <name> MEDIAPORTAL host[:port]`
Define a Mediaportal interface to communicate with a Wifiremote-Plugin of a Mediaportal-System.

`host[:port]`
The name and port of the Mediaportal-Wifiremote-Plugin. If Port is not given, the default of `8017` will be used.

#### Set

- Common Tasks
  - `connect`
    Connects to Mediaportal immediately without waiting for the normal Fhem-Timeout for reconnect (30s).
  - `powermode <mode>`
    One of (logoff, suspend, hibernate, reboot, shutdown, exit). Sets the powermode, e.g. shutdown, for shutdown the computersystem of the Mediaportal-System.
  - `reconnect`
    Re-Connects to Mediaportal immediately.
- Control-Commands
  - `command <command>`
    One of (stop, record, pause, play, rewind, forward, replay, skip, back, info, menu, up, down, left, right, ok, volup, voldown, volmute, chup, chdown, dvdmenu, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 0, clear, enter, teletext, red, blue, yellow, green, home, basichome, nowplaying, tvguide, tvrecs, dvd, playlists, first, last, fullscreen, subtitles, audiotrack, screenshot). Sends the given command to the player.
  - `key <keyvalue>`
    Sends the given key to the player.
  - `sleep`
    Sends the hinernate-signal to Mediaportal. This command is a shortcut for "powermode hibernate"
  - `wakeup`
    Wakes the Mediaportal-System up (WakeUp-On-LAN).
- Play-Commands
  - `playchannel <channelID>`
    Plays the channel with the given ID.
  - `playfile <fileType> <filePath>`
    Plays the given file with the given type. FileType can be one of (audio, video).
  - `playlist <command> <param>`
    Sends the given playlistcommand with the given parameter. Command can be one of (play, loadlist, loadlist_shuffle, loadfrompath, loadfrompath_shuffle).
  - `Volume <volumelevel>`
    Sets the Volume to the given value.

#### Get

- Common Tasks
  - `status`
    Call for the answer of a `status`-Message. e.g. Asynchronously retrieves the information of "Title" and "PlayStatus".
  - `nowplaying`
    Call for the answer of a `nowplaying`-Message. e.g. Asynchronously retrieves the information of "Duration", "Position" and "File"".

#### Attributes

- Common
  - `disable <value>`
    One of (0, 1). With this attribute you can disable the module.
  - `generateNowPlayingUpdateEvents <value>`
    One of (0, 1). With this value you can disable (or enable) the generation of `NowPlayingUpdate`-Events. If set, Fhem generates an event per second with the updated time-values for the current playing. Defaults to "0".
  - `HeartbeatInterval <interval>`
    In seconds. Defines the heartbeat interval in seconds which is used for testing the correct work of the connection to Mediaportal. A value of 0 deactivate the heartbeat-check. Defaults to "15".
  - `macaddress <address>`
    Sets the MAC-Address for the Player. This is needed for WakeUp-Function. e.g. "90:E6:BA:C2:96:15"
- Authentication
  - `authmethod <value>`
    One of (none, userpassword, passcode, both). With this value you can set the authentication-mode.
  - `password <value>`
    With this value you can set the password for authentication.
  - `username <value>`
    With this value you can set the username for authentication.

### MPD

FHEM module to control a MPD (or Mopidy) like the MPC (MPC = Music Player Command, the command line interface to the Music Player Daemon )
To install a MPD on a Raspberry Pi you will find a lot of documentation at the web e.g. http://www.forum-raspberrypi.de/Thread-tutorial-music-player-daemon-mpd-und-mpc-auf-dem-raspberry-pi in german
FHEM Forum : Modul für MPD ( in german )
Modul requires JSON -> sudo apt-get install libjson-perl
If you are using Mopidy with Spotify support you may also need LWP::UserAgent -> sudo apt-get install libwww-perl

Define

define <name> MPD <IP MPD Server | default localhost> <Port MPD Server | default 6600>
Example:

      define myMPD MPD 192.168.0.99 7000

if FHEM and MPD a running on the same device :

      define myMPD MPD

Set

`set <name> <what>`
Currently, the following commands are defined.
play => like MPC play , start playing song in playlist
clear => like MPC clear , delete MPD playlist
stop => like MPC stop, stops playing
pause => like MPC pause
previous => like MPC previous, play previous song in playlist
next => like MPC next, play next song in playlist
random => like MPC random, toggel on/off
repeat => like MPC repeat, toggel on/off
toggle => toggles from play to stop or from stop/pause to play
updateDb => like MPC update
volume (%) => like MPC volume %, 0 - 100
volumeUp => inc volume ( + attr volumeStep size )
volumeDown => dec volume ( - attr volumeStep size )
playlist (playlistname|songnumber|position) set playlist on MPD Server. If songnumber and/or postion not defined
MPD starts playing with the first song at position 0
playfile (file) => create playlist + add file to playlist + start playing
IdleNow => send Idle command to MPD and wait for events to return
reset => reset MPD Modul
mpdCMD (cmd) => send a command to MPD Server ( MPD Command Ref )
mute => on,off,toggle
seekcur (time) => Format: [[hh:]mm:]ss. Not before MPD version 0.20.
forward => jump forward in the current track as far as defined in the seekStep Attribute, default 7%
rewind => jump backwards in the current track, as far as defined in the seekStep Attribute, default 7%
channel (no) => loads the playlist with the given number
channelUp => loads the next playlist
channelDown => loads the previous playlist
save_bookmark => saves the current state of the playlist (track number and position inside the track) for the currently loaded playlist This will only work if the playlist was loaded through the module and if the attribute bookmarkDir is set. (not on radio streams !)
load_bookmark <name> => resumes the previously saved state of the currently loaded playlist and jumps to the associated tracknumber and position inside the track

Get

`get <name> <what>`
Currently, the following commands are defined.
music => list all MPD music files in MPD databse
playlists => list all MPD playlist in MPD databse
playlistsinfo => show current playlist informations
webrc => HTML output for a simple Remote Control on FHEM webpage e.g :.

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

statusRequest => get MPD status
currentsong => get infos from current song in playlist
outputs => get name,id,status about all MPD output devices in /etc/mpd.conf
bookmarks => list all stored bookmarks

Attributes

- password <pwd>, if password in mpd.conf is set
- loadMusic 1|0 => load titles from MPD database at startup (not supported by modipy)
- loadPlaylists 1|0 => load playlist names from MPD database at startup
- volumeStep 1|2|5|10 => Step size for Volume +/- (default 5)
- titleSplit 1|0 => split title to artist and title if no artist is given in songinfo (e.g. radio-stream default 1)
- timeout (default 1) => timeout in seconds for TCP connection timeout
- waits (default 60) => if idle process ends with error, seconds to wait
- stateMusic 1|0 => show Music DropDown box in web frontend
- statePlaylists 1|0 => show Playlists DropDown box in web frontend
- player mpd|mopidy|forked-daapd => which player is controlled by the module
- Cover Art functions from Last.fm :
- image_size -1|0|1|2|3 (default -1 = don't use artist images and album cover from Last.fm)
  Last.fm is using diffrent image sizes :
  0 = 32x32 , 1 = 64x64 , 2 = 174x174 , 3 = 300x300
- artist_content 0|1 => store artist informations in Reading artist_content
- artist_summary 0|1 => stote more artist informations in Reading artist_summary
  Example with readingsGroup :

             define rg_artist readingsGroup <MPD name>:artist,artist_image_html,artist_summary
            attr rg_artist room MPD

- cache (default lfm => /fhem/www/lfm) store artist image and album cover in a local directory
- unknown_artist_image => show this image if no other image is avalible (default : /fhem/icons/1px-spacer)
- bookmarkDir => set a writeable directory here to enable saving and restoring of playlist states using the set bookmark and get bookmark commands
- autoBookmark => set this to 1 to enable automatic loading and saving of playlist states whenever the playlist is changed using this module
- seekStep => set this to define how far the forward and rewind commands jump in the current track. Defaults to 7 if not set
- seekStepSmall (default 1) => set this on top of seekStep to define a smaller step size, if the current playing position is below seekStepThreshold percent. This is useful to skip intro music, e.g. in radio plays or audiobooks.
- seekStepSmallThreshold (default 0) => used to define when seekStep or seekStepSmall is applied. Defaults to 0. If set e.g. to 10, then during the first 10% of a track, forward and rewind are using the seekStepSmall value.
- no_playlistcollection (default 0) => if set to 1 , dont create reading playlistcollection

Readings

all MPD internal values
artist_image : (if using Last.fm)
artist_image_html : (if using Last.fm)
album_image : (if using Last.fm)
album_image_html : (if using Last.fm)
artist_content : (if using Last.fm)
artist_summary : (if using Last.fm)
currentTrackProvider : Radio / Bibliothek
playlistinfo : (TabletUI Medialist)
playlistcollection : (TabletUI)
playlistname : (TabletUI) current playlist name
playlist_num : current playlist number
playlist_json : (Medialist Modul)
rawTitle : Title information without changes from the modul

### MQTT

connects fhem to mqtt.

A single MQTT device can serve multiple MQTT_DEVICE and MQTT_BRIDGE clients.
Each MQTT_DEVICE acts as a bridge in between an fhem-device and mqtt.
Note: this module is based on Net::MQTT which needs to be installed from CPAN first.

Define

`define <name> MQTT <ip:port> [<username>] [<password>]`

Specifies the MQTT device.

Set

- `set <name> connect`
  (re-)connects the MQTT-device to the mqtt-broker

- `set <name> disconnect`
  disconnects the MQTT-device from the mqtt-broker

Attributes

- keep-alive
  sets the keep-alive time (in seconds).

### MQTT_BRIDGE

acts as a bridge in between an fhem-device and mqtt-topics.

requires a MQTT-device as IODev
Note: this module is based on Net::MQTT which needs to be installed from CPAN first.

Define

`define <name> MQTT_BRIDGE <fhem-device-name>`

Specifies the MQTT device.
<fhem-device-name> is the fhem-device this MQTT_BRIDGE is linked to.

Get

- `get <name> readings`
  retrieves all existing readings from fhem-device and configures (default-)topics for them.
  attribute 'publish-topic-base' is prepended if set.

Attributes

- `attr <name> subscribeSet <topic>`
  configures a topic that will issue a 'set <message> whenever a message is received

- `attr <name> subscribeSet_<reading> <topic>`
  configures a topic that will issue a 'set <reading> <message> whenever a message is received

- `attr <name> publishState <topic>`
  configures a topic such that a message is sent to topic whenever the device state changes.

- `attr <name> publishReading_<reading> <topic>`
  configures a topic such that a message is sent to topic whenever the device readings value changes.

- `attr <name> publish-topic-base <topic>`
  this is used as base path when issueing 'get <device> readings' to construct topics to publish to based on the devices existing readings

### MQTT_DEVICE

acts as a fhem-device that is mapped to mqtt-topics.

requires a MQTT-device as IODev
Note: this module is based on Net::MQTT which needs to be installed from CPAN first.

Define

`define <name> MQTT_DEVICE`
Specifies the MQTT device.

Set

- `set <name> <command>`
  sets reading 'state' and publishes the command to topic configured via attr publishSet

- `set <name> <h;reading> <value>`
  sets reading <h;reading> and publishes the command to topic configured via attr publishSet_<h;reading>

Attributes

- `attr <name> publishSet [<commands>] <topic>`
  configures set commands that may be used to both set reading 'state' and publish to configured topic

- `attr <name> publishSet_<reading> [<values>] <topic>`
  configures reading that may be used to both set 'reading' (to optionally configured values) and publish to configured topic

- `attr <name> autoSubscribeReadings <topic>`
  specify a mqtt-topic pattern with wildcard (e.c. 'myhouse/kitchen/+') and MQTT_DEVICE automagically creates readings based on the wildcard-match
  e.g a message received with topic 'myhouse/kitchen/temperature' would create and update a reading 'temperature'

- `attr <name> subscribeReading_<reading> <topic>`
  mapps a reading to a specific topic. The reading is updated whenever a message to the configured topic arrives

### msg

`msg [<type>] [<@device>|<e-mail address>] [<priority>] [|<title>|] <message>`
No documentation here yet, sorry.
FHEM Forum

### MSGFile

The MSGFile device is used to write arbitrary data to a file on disk or other media accessable through the filesystem. In order to write to a file, the access rights of the FHEM process to the specified file and path are relevant. To set the rights for a directory, please use OS related commands.
Define

`define <name> MSGFile <filename>`
Specifies the MSGFile device. At definition the message counter is set to 0. A filename must be specified at definition.

Examples:

`define myFile MSGFile`

Set

`set <name> add|clear|list|write [text]`
Set is used to manipulate the message buffer of the device. The message buffer is an array of lines of data, stored serial based on the incoming time into the buffer. Lines of data inside the buffer could not be deleted anymore, except of flashing the whole buffer.

add
to add lines of data to the message buffer. All data behind "add" will be interpreted as text message. To add a carriage return to the data, please use the CR attribute.

clear
to flash the message buffer and set the line counter to 0. All the lines of data are deleted and the buffer is flushed.

list
to list the message buffer.

write
to write the message buffer to the associated file.

Examples:

`set myFile add Dies ist Textzeile 1`
`set myFile add Dies ist Textzeile 2`
`set myFile clear`
Full working example to write two lines of data to a file:
`define myFile MSGFile /tmp/fhemtest.txt`
`attr myFile filemode append`
`set myFile add Textzeile 1`
`set myFile add Textzeile 2`
`set myFile write`
`set myFile clear`

Attributes

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

### MSGMail

The MSGMail device is used to send mail messages to a recipient by connecting to a SMTP server. Currently MSGMail supports only servers, that allow SSL secured connections like Googlemail, GMX, Yahoo or 1und1. MSGMail requires the perl pacakge MAIL::Lite. For SSL support, Net::SMTP version 3.06 is required. On systems with an older version of Net::SMTP, MSGMail requires the package Net::SMTP::SSL.
Define

`define <name> MSGMail <from> <to> <smtphost> <authfile>`
Specifies the MSGMail device. At definition the message counter is set to 0. From, To, SMTPHost and the authfile (see attributes below) need to be defined at definition time.

Examples:

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

Set

`set <name> add|clear|list|send [text]`
Set is used to manipulate the message buffer of the device. The message buffer is an array of lines of data, stored serial based on the incoming time into the buffer. Lines of data inside the buffer could not be deleted anymore, except of flashing the whole buffer.

add
to add lines of data to the message buffer. All data behind "add" will be interpreted as text message. To add a carriage return to the data, please use the CR attribute.

clear
to flush the message buffer and set the line counter to 0. All the lines of data are deleted and the buffer is flushed.

list
to list the message buffer.

send
to send the message buffer.

Examples:

`set myMail add Dies ist Textzeile 1`
`set myMail add Dies ist Textzeile 2`
`set myMail clear`
Full working example to send two lines of data to a recipent:
`define myMail MSGMail donald.duck@entenhausen.com dagobert.duck@duck-banking.com smtp.entenhausen.net /etc/fhem/msgmailauth`
`attr myMail smtpport 9999`
`attr myMail subject i need more money`
`attr myMail CR 0`
`set myMail add Please send me`
`set myMail add 1.000.000 Taler`
`set myMail send`
`set myMail clear`

Attributes

Almost all of these attributes are not optional, most of them could set at definition.
- from
  sets the mail address of the sender
- to
  sets the mail address of the recipent
- smtphost
  sets the name of the smtphost, for example for GMX you could use mail.gmx.net or for Googlemail the smtphost is smtp.googlemail.com
- smtpport (optional)
  sets the port of the smtphost, for example for GMX or for Googlemail the smtport is 465, which is also the default and do not need to be set
- subject (optional)
  sets the subject of this email. Per default the subject is set to "FHEM"
- authfile
  sets the authfile for the SSL connection to the SMTP host
  the authfile is a simple textfile with the userid in line 1 and the password in line 2.
  Example:
  `123user45`
  `strenggeheim`
  It is a good behaviour to protect this data and put the file, for example into the /etc directory and set the rights to 440 (chmod 440 /etc/msgmailauthfile), so that not everyone could see the contents of the file. FHEM must have access to this file to read the userid and password.
- mailtype plain|html
  Use this attribute to select the contenttype to text/plain or text/html. If text/html is selected, valid html code must be provided as content. No checks are applied! Per default this attribute is 'plain'
- CR
  set the option to write a carriage return at the end of the line. CR could be set to 0 or 1, 1 enables this feature. Per default this attribute is enabled
- loglevel

### MYSENSORS

connects fhem to MYSENSORS.

A single MYSENSORS device can serve multiple MYSENSORS_DEVICE clients.
Each MYSENSORS_DEVICE represents a mysensors node.

Define

`define <name> MYSENSORS <serial device>|<ip:port>`

Specifies the MYSENSORS device.

Set

- `set <name> connect`
  (re-)connects the MYSENSORS-device to the MYSENSORS-gateway

- `set <name> disconnect`
  disconnects the MYSENSORS-device from the MYSENSORS-gateway

- `set <name> inclusion-mode on|off`
  turns the gateways inclusion-mode on or off

Attributes

- `att <name> autocreate`
  enables auto-creation of MYSENSOR_DEVICE-devices on receival of presentation-messages

- `att <name> requestAck`
  request acknowledge from nodes.
  if set the Readings of nodes are updated not before requested acknowledge is received
  if not set the Readings of nodes are updated immediatly (not awaiting the acknowledge). May also be configured for individual nodes if not set for gateway.

- `att <name> first-sensorid <<number <h; 255>>`
  configures the lowest node-id assigned to a mysensor-node on request (defaults to 20)

### MYSENSORS_DEVICE

represents a mysensors sensor attached to a mysensor-node

requires a MYSENSOR-device as IODev

Define

`define <name> MYSENSORS_DEVICE <Sensor-type> <node-id>`
Specifies the MYSENSOR_DEVICE device.

Set

- `set <name> clear`
  clears routing-table of a repeater-node

- `set <name> time`
  sets time for nodes (that support it)

- `set <name> reboot`
  reboots a node (requires a bootloader that supports it).
  Attention: Nodes that run the standard arduino-bootloader will enter a bootloop!
  Dis- and reconnect the nodes power to restart in this case.

Attributes

- `attr <name> config [<M|I>]`
  configures metric (M) or inch (I). Defaults to 'M'

- `attr <name> setCommands [<command:reading:value>]*`
  configures one or more commands that can be executed by set.
  e.g.: `attr <name> setCommands on:switch_1:on off:switch_1:off`
  if list of commands contains both 'on' and 'off' set extensions are supported

- `attr <name> setReading_<reading> [<value>]*`
  configures a reading that can be modified by set-command
  e.g.: `attr <name> setReading_switch_1 on,off`

- `attr <name> mapReading_<reading> <childId> <readingtype> [<value>:<mappedvalue>]*`
  configures the reading-name for a given childId and sensortype
  E.g.: `attr xxx mapReading_aussentemperatur 123 temperature`

- `att <name> requestAck`
  request acknowledge from nodes.
  if set the Readings of nodes are updated not before requested acknowledge is received
  if not set the Readings of nodes are updated immediatly (not awaiting the acknowledge).
  May also be configured on the gateway for all nodes at once

- `attr <name> mapReadingType_<reading> <new reading name> [<value>:<mappedvalue>]*`
  configures reading type names that should be used instead of technical names
  E.g.: `attr xxx mapReadingType_LIGHT switch 0:on 1:off` to be used for mysensor Variabletypes that have no predefined defaults (yet)

### MaxScanner

The MaxScanner-Module enables FHEM to capture temperature and valve-position of thermostats in regular intervals.

Define

`define <name> MaxScanner`

Set-Commands

`set <name> run`

Runs the scanner loop immediately. (Is usually done by timer)

Get-Commands

`get <name> associatedDevices`

Gets the asscociated devices (thermostats, shutterContacts)

Attributes for the Scanner-Device

- readingFnAttributes

- disable
  When value=1, then the scanner device is disabled; possible values: 0,1; default: 0

- scnCreditThreshold
  the minimum value of available credits; when lower, the scanner will remain inactive; possible values: 150..600; default: 300

- scnMinInterval
  scan interval in minutes, when the calculated interval is lower, then scnMinintervall will be used instead;possible values: 3..60; default: 3

User-Attributes for the Thermostat-Device

- scanTemp
  When value=1, then scanner will use the thermostat; possible values: 0,1; default: 0

- scnProcessByDesiChange
  When value=1, then scanner will use method "desired change" instead of "mode change"; possible values: 0,1; default: 0

- scnModeHandling
  When scnProcessByDesiChange is active, this attribute select the way of handling the mode of the thermostat; possible values: [NOCHANGE,AUTO,MANUAL];default: AUTO

- scnShutterList
  comma-separated list of shutterContacts associated with the thermostat

Additional information

- Discussion in FHEM forum
- WIKI information in FHEM Wiki

### MilightBridge

This module is the interface to a Milight Bridge which is connected to the network using a Wifi connection. It uses a UDP protocal with no acknowledgement so there is no guarantee that your command was received.

The Milight system is sold under various brands around the world including "LimitlessLED, EasyBulb, AppLamp"

The API documentation is available here: http://www.limitlessled.com/dev/

Define

`define <name> MilightBridge <host/ip:port>`

Specifies the MilightBridge device.
<host/ip> is the hostname or IP address of the Bridge with optional port (defaults to 8899 if not defined, use 50000 for V1,V2 bridges)

Readings

- state
  [Initialized|ok|unreachable]: Shows reachable status of bridge using "ping" check every 10 (checkInterval) seconds.
- sendFail
  0 if everything is OK. 1 if the send function was unable to send the command - this would indicate a problem with your network and/or host/port parameters.
- slot[0|1|2|3|4|5|6|7|8]
  The slotX reading will display the name of the MilightDevice that is defined with this Bridge as it's IODev. It will be blank if no device is defined for that slot.

Attributes

- sendInterval
  Default: 100ms. The bridge has a minimum send delay of 100ms between commands.
- checkInterval
  Default: 10s. Time after the bridge connection is re-checked.
  If this is set to 0 checking is disabled and state = "Initialized".
- protocol
  Default: udp. Change to tcp if you have enabled tcp mode on your bridge.
- tcpPing
  If this attribute is defined, ping will use TCP instead of UDP.

### MilightDevice

This module represents a Milight LED Bulb or LED strip controller. It is controlled by a MilightBridge.

The Milight system is sold under various brands around the world including "LimitlessLED, EasyBulb, AppLamp"

The API documentation is available here: http://www.limitlessled.com/dev/

Requires perl module Math::Round

Define

`define <name> MilightDevice <devType(RGB|RGBW|White)> <IODev> <slot>`

Specifies the Milight device.
<devType> One of RGB, RGBW, White depending on your device.
<IODev> The MilightBridge which the device is paired with.
<slot> The slot on the MilightBridge that the device is paired with or 'A' to group all slots.

Readings

- state
  [on xxx|off|night]: Current state of the device / night mode (xxx = 0-100%).
- brightness
  [0-100]: Current brightness level in %.
- brightness_on
  [0-100]: The brightness level before the off command was sent. This allows the light to turn back on to the last brightness level.
- rgb
  [FFFFFF]: HEX value for RGB.
- previousState
  [hsv]: hsv value before last change. Can be used with restorePreviousState set command.
- savedState
  [hsv]: hsv value that was saved using saveState set function
- hue
  [0-360]: Current hue value.
- saturation
  [0-100]: Current saturation value.
- transitionInProgress
  [0|1]: Set to 1 if a transition is currently in progress for this device (eg. fade).
- discoMode
  [0|1]: 1 if discoMode is enabled, 0 otherwise.
- discoSpeed
  [0|1]: 1 if discoSpeed is increased, 0 if decreased. Does not mean much for RGBW
- lastPreset
  [0..X]: Last selected preset.
- ct
  [1-10]: Current colour temperature (3000=Warm,6500=Cold) for White devices.

Set

- on <ramp_time (seconds)>
- off <ramp_time (seconds)>
- toggle
- night
- dim <percent(0..100)> [seconds(0..x)] [flags(l=long path|q=don't clear queue)]
  Will be replaced by brightness at some point
- dimup <percent change(0..100)> [seconds(0..x)]
  Special case: If percent change=100, seconds will be adjusted for actual change to go from current brightness.
- dimdown <percent change(0..100)> [seconds(0..x)]
  Special case: If percent change=100, seconds will be adjusted for actual change to go from current brightness.
- pair
  May not work properly. Sometimes it is necessary to use a remote to clear pairing first.
- unpair
  May not work properly. Sometimes it is necessary to use a remote to clear pairing first.
- restorePreviousState
  Set device to previous hsv state as stored in previousState reading.
- saveState
  Save current hsv state to savedState reading.
- restoreState
  Set device to saved hsv state as stored in savedState reading.
- preset (0..X|+)
  Load preset (+ for next preset).
- hsv <h(0..360)>,<s(0..100)>,<v(0..100)> [seconds(0..x)] [flags(l=long path|q=don't clear queue)]
  Set hsv value directly
- rgb RRGGBB [seconds(0..x)] [flags(l=long path|q=don't clear queue)]
  Set rgb value directly or using colorpicker.
- hue <(0..360)> [seconds(0..x)] [flags(l=long path|q=don't clear queue)]
  Set hue value.
- saturation <s(0..100)> [seconds(0..x)] [flags(q=don't clear queue)]
  Set saturation value directly
- discoModeUp
  Next disco Mode setting (for RGB and RGBW).
- discoModeDown
  Previous disco Mode setting (for RGB).
- discoSpeedUp
  Increase speed of disco mode (for RGB and RGBW).
- discoSpeedDown
  Decrease speed of disco mode (for RGB and RGBW).
- ct <3000-6500>
  Colour temperature 3000=Warm White,6500=Cold White (10 steps) (for White devices only).
- set extensions are supported.

Get

- rgb
- hsv

Attributes

- dimStep
  Allows you to modify the default dimStep if required.
- defaultRampOn
  Set the default ramp time if not specified for on command.
- defaultRampOff
  Set the default ramp time if not specified for off command.
- presets
  List of hsv presets separated by spaces (eg 0,0,100 9,0,50).
- colorCast
  Color shift values for red,yellow,green,cyan,blue,magenta (-29..29) for HSV color correction (eg 0,5,10,-5,0,0)
- gamma
  Set gamma correction value for device (eg 0.8)
- dimOffWhite
  Use a different switching logic for White bulbs to better handle packet loss.
- updateGroupDevices
  Update the state of single devices switched with slot 'A'.
- restoreAtStart
  Restore the state of devices at startup. Default 0 for slot 'A', 1 otherwise.
- defaultBrightness
  Set the default brightness if not known. (Default: 36)

### Modbus

Modbus defines a physical modbus interface and functions to be called from other logical modules / devices. This low level module takes care of the communication with modbus devices and provides Get, Set and cyclic polling of Readings as well as formatting and input validation functions. The logical device modules for individual machines only need to define the supported modbus function codes and objects of the machine with the modbus interface in data structures. These data structures are then used by this low level module to implement Set, Get and automatic updateing of readings in a given interval.
This version of the Modbus module supports Modbus RTU and ASCII over serial / RS485 lines as well as Modbus TCP and Modbus RTU or RTU over TCP. It defines read / write functions for Modbus holding registers, input registers, coils and discrete inputs.
Prerequisites

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

Define

`define <name> Modbus <device>`
A define of a physical device based on this module is only necessary if a shared physical device like a RS485 USB adapter is used. In the case of Modbus TCP this module will be used as a library for other modules that define all the data objects and no define of the base module is needed.
Example:

`define ModBusLine Modbus /dev/ttyUSB1@9600`

In this example the module opens the given serial interface and other logical modules can access several Modbus devices connected to this bus concurrently. If your device needs special communications parameters like even parity you can add the number of data bits, the parity and the number of stopbits separated by commas after the baudrate e.g.:

`define ModBusLine Modbus /dev/ttyUSB2@38400,8,E,2`

Set-Commands

this low level device module doesn't provide set commands for itself but implements set for logical device modules that make use of this module. See ModbusAttr for example.

Get-Commands

this low level device module doesn't provide get commands for itself but implements get for logical device modules that make use of this module.

Attributes

- do_not_notify
- readingFnAttributes
- queueDelay
modify the delay used when sending requests to the device from the internal queue, defaults to 1 second
- busDelay
defines a delay that is always enforced between the last read from the bus and the next send to the bus for all connected devices
- clientSwitchDelay
defines a delay that is always enforced between the last read from the bus and the next send to the bus for all connected devices but only if the next send goes to a different device than the last one
- queueMax
max length of the send queue, defaults to 100
- dropQueueDoubles
prevents new request to be queued if the same request is already in the send queue
- profileInterval
if set to something non zero it is the time period in seconds for which the module will create bus usage statistics. Pleas note that this number should be at least twice as big as the interval used for requesting values in logical devices that use this physical device
The bus usage statistics create the following readings:

- Profiler_Delay_sum
seconds used as delays to implement the defined sendDelay and commDelay
- Profiler_Fhem_sum
seconds spend processing in the module
- Profiler_Idle_sum
idle time
- Profiler_Read_sum
seconds spent reading and validating the data read
- Profiler_Send_sum
seconds spent preparing and sending data
- Profiler_Wait_sum
seconds waiting for a response to a request
- Statistics_Requests
number of requests sent
- Statistics_Timeouts
timeouts encountered

### ModbusAttr

ModbusAttr uses the low level Modbus module 98_Modbus.pm to provide a generic Modbus module for devices that can be defined by attributes similar to the way HTTPMOD works for devices with a web interface.
Prerequisites

- This module requires the basic Modbus module which itsef requires DevIO which again requires Device::SerialPort or Win32::SerialPort module if you connect devices to a serial port.

Define

`define <name> ModbusAttr <Id> <Interval>`
or
`define <name> ModbusAttr <Id> <Interval> <Address:Port> <RTU|ASCII|TCP>`
The module connects to the Modbus device with Modbus Id <Id> through an already defined serial modbus device (RS232 or RS485) or directly through Modbus TCP or Modbus RTU or ASCII over TCP and actively requests data from that device every <Interval> seconds
Examples:

`define WP ModbusAttr 1 60`

to go through a serial interface managed by an already defined basic modbus device. The protocol defaults to Modbus RTU
or

`define WP ModbusAttr 20 0 ASCII`

to go through a serial interface managed by an already defined basic modbus device with Modbus ASCII. Use Modbus Id 20 and don't query the device in a defined interval. Instead individual SET / GET options have to be used for communication.
or

`define WP ModbusAttr 5 60 192.168.1.122:504 TCP`

to talk Modbus TCP
or

`define WP ModbusAttr 3 60 192.168.1.122:8000 RTU`

to talk Modbus RTU over TCP

Configuration of the module

The data objects (holding registers, input registers, coils or discrete inputs) of the device to be queried are defined using attributes. The attributes assign objects with their address to readings inside fhem and control how these readings are calculated from the raw values and how they are formatted.
Objects can also be written to the device and attributes define how this is done.
Example:

            define PWP ModbusAttr 5 30
            attr PWP obj-h256-reading Temp_Wasser_ein
            attr PWP obj-h256-expr $val/10

            attr PWP obj-h258-reading Temp_Wasser_Aus
            attr PWP obj-h258-expr $val/10

            attr PWP obj-h262-reading Temp_Luft
            attr PWP obj-h262-expr $val / 10

            attr PWP obj-h770-reading Temp_Soll
            attr PWP obj-h770-expr $val / 10
            attr PWP obj-h770-set 1
            attr PWP obj-h770-setexpr $val * 10
            attr PWP obj-h770-max 32
            attr PWP obj-h770-min 10
            attr PWP obj-h770-hint 8,10,20,25,28,29,30,30.5,31,31.5,32

            attr PWP dev-h-combine 5
            attr PWP dev-h-defPoll 1

            attr PWP room Pool-WP
            attr PWP stateFormat {sprintf("%.1f Grad", ReadingsVal($name,"Temp_Wasser_Ein",0))}
            attr PWP webCmd Temp_Soll

Attributes to define data objects start with obj- followed by a code that identifies the type and address of the data object.
Modbus devices offer the following types of data objects: holding registers (16 bit objects that can be read and written), input registers (16 bit objects that can only be read), coils (single bit objects that can be read and written) or discrete inputs (single bit objects that can only be read).
The module uses the first character of these data object types to define attributes. Thus h770 refers to a holding register with the decimal address 770 and c120 refers to a coil with address 120. The address has to be specified as pure decimal number without any leading zeros or spaces.
`attr PWP obj-h258-reading Temp_Wasser_Aus` defines a reading with the name Temp_Wasser_Aus that is read from the Modbus holding register at address 258.
With the attribute ending on `-expr` you can define a perl expression to do some conversion or calculation on the raw value read from the device. In the above example the raw value has to be devided by 10 to get the real value. If the raw value is also the final value then no `-expr` attribute is necessary.
An object attribute ending on `-set` creates a fhem set option. In the above example the reading Temp_Soll can be changed to 12 degrees by the user with the fhem command `set PWP Temp_Soll 12`
The object attributes ending on `-min` and `-max` define min and max values for input validation and the attribute ending on `-hint` will tell fhem to create a selection list so the user can graphically select the defined values.
To define general properties of the device you can specify attributes starting with `dev-`. E.g. with `dev-timing-timeout` you can specify the timeout when waiting for a response from the device. With `dev-h-` you can specify several default values or general settings for all holding registers like the function code to be used when reading or writing holding registers. These attributes are optional and the module will use defaults that work in most cases.
`dev-h-combine 5` for example allows the module to combine read requests to objects having an address that differs 5 or less into one read request. Without setting this attribute the module will start individual read requests for each object. Typically the documentation for the modbus interface of a given device states the maximum number of objects that can be read in one function code 3 request.

Set-Commands

are created based on the attributes defining the data objects.
Every object for which an attribute like `obj-xy-set` is set to 1 will create a valid set option.
Additionally the attribute `enableControlSet` enables the set options `interval`, `stop`, `start`, `reread` as well as `scanModbusObjects`, `scanStop` and `scanModbusIds` (for devices connected with RTU / ASCII over a serial line).

- `interval <Interval>`
modifies the interval that was set during define.
- `stop`
stops the interval timer that is used to automatically poll objects through modbus.
- `start`
starts the interval timer that is used to automatically poll objects through modbus. If an interval is specified during the define command then the interval timer is started automatically. However if you stop it with the commend `set <mydevice> stop` thd you can start it again with `set <mydevice> start`.
- `reread`
causes a read of all objects that are set to be polled in the defined interval. The interval timer is not modified.
- `scanModbusObjects <startObj> - <endObj> <reqLen>`
scans the device objects and automatically creates attributes for each reply it gets. This might be useful for exploring devices without proper documentation. The following example starts a scan and queries the holding registers with addresses between 100 and 120.
`set MyModbusAttrDevice scanModbusObjects h100-120`
For each reply it gets, the module creates a reading like
`scan-h100 hex=0021, len=2, string=.!, s=8448, s>=33, S=8448, S>=33`
len=2 means that the result did contain 2 bytes (one register), its representation as hex is 0021 and the ASCII representation is .!. s, s>, S and S> are different representations with their Perl pack-code.
- `scanModbusIds <startId> - <endId> <knownObj>`
scans for Modbus Ids on an RS485 Bus. The following set command for example starts a scan:
`set Device scanModbusId 1-7 h770`
since many modbus devices don't reply at all if an object is requested that does not exist, scanModbusId needs the adress of an object that is known to exist. If a device with Id 5 replies to a read request for holding register 770, a reading like the following will be created:
`scanId-5-Response-h770 hex=0064, len=2, string=.d, s=25600, s>=100, S=25600, S>=100`
- `scanStop`
stops any running scans.

Get-Commands

All readings 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, the objects visible as Get in FHEMWEB can be defined by setting an attribute `obj-xy-showGet` to 1.

Attributes

- do_not_notify
- readingFnAttributes
- alignTime
Aligns each periodic read request for the defined interval to this base time. This is typcally something like 00:00 (see the Fhem at command)
- enableControlSet
enables the built in set commands interval, stop, start and reread
please also notice the attributes for the physical modbus interface as documented in 98_Modbus.pm
the following list of attributes can be applied to any data object by specifying the objects type and address in the variable part. For many attributes you can also specify default values per object type (see dev- attributes later) or you can specify an object attribute without type and address (e.g. obj-len) which then applies as default for all objects:
- obj-[cdih][1-9][0-9]*-reading
define the name of a reading that corresponds to the modbus data object of type c,d,i or h and a decimal address (e.g. obj-h225-reading).
- obj-[cdih][1-9][0-9]*-name
defines an optional internal name of this data object (this has no meaning for fhem and serves mainly documentation purposes.
- obj-[cdih][1-9][0-9]*-set
if set to 1 then this data object can be changed (works only for holding registers and coils since discrete inputs and input registers can not be modified by definition.
- obj-[cdih][1-9][0-9]*-min
defines a lower limit to the value that can be written to this data object. This ist just used for input validation.
- obj-[cdih][1-9][0-9]*-max
defines an upper limit to the value that can be written to this data object. This ist just used for input validation.
- obj-[cdih][1-9][0-9]*-hint
this is used for set options and tells fhemweb what selection to display for the set option (list or slider etc.)
- obj-[cdih][1-9][0-9]*-expr
defines a perl expression that converts the raw value read from the device.
- obj-[cdih][1-9][0-9]*-map
defines a map to convert values read from the device to more convenient values when the raw value is read from the device or back when the value to write has to be converted from the user value to a raw value that can be written. Example: 0:mittig, 1:oberhalb, 2:unterhalb
- obj-[cdih][1-9][0-9]*-setexpr
defines a perl expression that converts the user specified value in a set to a raw value that can be sent to the device. This is typically the inversion of -expr above.
- obj-[cdih][1-9][0-9]*-format
defines a format string to format the value read e.g. %.1f
- obj-[cdih][1-9][0-9]*-len
defines the length of the data object in registers. It defaults to 1. Some devices store 32 bit floating point values in two registers. In this case you should set this attribute to two.
- obj-[cdih][1-9][0-9]*-unpack
defines the unpack code to convert the raw data string read from the device to a reading. For an unsigned integer in big endian format this would be "n", for a signed 16 bit integer in big endian format this would be "s>" and for a 32 bit big endian float value this would be "f>". (see the perl documentation of the pack function).
Please note that you also have to set a -len attribute (for this object or for the device) if you specify an unpack code that consumes data from more than one register.
For a 32 bit float len should be at least 2.
- obj-[cdih][1-9][0-9]*-revRegs
this is only applicable to objects that span several input registers or holding registers.
when they are read then the order of the registers will be reversed before further interpretation / unpacking of the raw register string. The same happens before the object is written with a set command.
- obj-[cdih][1-9][0-9]*-bswapRegs
this is applicable to objects that span several input or holding registers.
After the registers have been read and before they are writtem, all 16-bit values are treated big-endian and are reversed to little-endian by swapping the two 8 bit bytes. This functionality is most likely used for reading (ASCII) strings from the device that are stored as big-endian 16-bit values.
example: original reading is "324d3130203a57577361657320722020". After applying bswapRegs, the value will be "4d3230313a2057576173736572202020" which will result in the ASCII string "M201: WWasser ". Should be used with "(a*)" as -unpack value.
- obj-[cdih][1-9][0-9]*-decode
defines an encoding to be used in a call to the perl function decode to convert the raw data string read from the device to a reading. This can be used if the device delivers strings in an encoding like cp850 instead of utf8.
- obj-[cdih][1-9][0-9]*-encode
defines an encoding to be used in a call to the perl function encode to convert the raw data string read from the device to a reading. This can be used if the device delivers strings in an encoding like cp850 and after decoding it you want to reencode it to e.g. utf8.
- obj-[cdih][1-9][0-9]*-showGet
every reading can also be requested by a get command. However these get commands are not automatically offered in fhemweb. By specifying this attribute, the get will be visible in fhemweb.
- obj-[cdih][1-9][0-9]*-poll
if set to 1 then this obeject is included in the cyclic update request as specified in the define command. If not set, then the object can manually be requested with a get command, but it is not automatically updated each interval. Note that this setting can also be specified as default for all objects with the dev- atributes described later.
- obj-[cdih][1-9][0-9]*-polldelay
this attribute allows to poll objects at a lower rate than the interval specified in the define command. You can either specify a time in seconds or number prefixed by "x" which means a multiple of the interval of the define command.
If you specify a normal numer then it is interpreted as minimal time between the last read and another automatic read. Please note that this does not create an additional interval timer. Instead the normal interval timer defined by the interval of the define command will check if this reading is due or not yet. So the effective interval will always be a multiple of the interval of the define.
- dev-([cdih]-)*read
specifies the function code to use for reading this type of object. The default is 3 for holding registers, 1 for coils, 2 for discrete inputs and 4 for input registers.
- dev-([cdih]-)*write
specifies the function code to use for writing this type of object. The default is 6 for holding registers and 5 for coils. Discrete inputs and input registers can not be written by definition.
- dev-([cdih]-)*combine
defines how many adjacent objects can be read in one request. If not specified, the default is 1
- dev-([cdih]-)*allowShortResponses
if set to 1 the module will accept a response with valid checksum but data lengh < lengh in header
- dev-([cdih]-)*defLen
defines the default length for this object type. If not specified, the default is 1
- dev-([cdih]-)*defFormat
defines a default format string to use for this object type in a sprintf function on the values read from the device.
- dev-([cdih]-)*defExpr
defines a default Perl expression to use for this object type to convert raw values read.
- dev-([cdih]-)*defUnpack
defines the default unpack code for this object type.
- dev-([cdih]-)*defRevRegs
defines that the order of registers for objects that span several registers will be reversed before further interpretation / unpacking of the raw register string
- dev-([cdih]-)*defBswapRegs
per device default for swapping the bytes in Registers (see obj-bswapRegs above)
- dev-([cdih]-)*defDecode
defines a default for decoding the strings read from a different character set e.g. cp850
- dev-([cdih]-)*defEncode
defines a default for encoding the strings read (or after decoding from a different character set) e.g. utf8
- dev-([cdih]-)*defPoll
if set to 1 then all objects of this type will be included in the cyclic update by default.
- dev-([cdih]-)*defShowGet
if set to 1 then all objects of this type will have a visible get by default.
- dev-timing-timeout
timeout for the device (defaults to 2 seconds)
- dev-timing-sendDelay
delay to enforce between sending two requests to the device. Default ist 0.1 seconds.
- dev-timing-commDelay
delay between the last read and a next request. Default ist 0.1 seconds.
- nextOpenDelay
delay for Modbus-TCP connections. This defines how long the module should wait after a failed TCP connection attempt before the next reconnection attempt. This defaults to 60 seconds.
- openTimeout
timeout to be used when opening a Modbus TCP connection (defaults to 3)
- timeoutLogLevel
log level that is used when logging a timeout. Defaults to 3.
- silentReconnect
if set to 1, then it will set the loglevel for "disconnected" and "reappeared" messages to 4 instead of 3
- maxTimeoutsToReconnect
this attribute is only valid for TCP connected devices. In such cases a disconnected device might stay undetected and lead to timeouts until the TCP connection is reopened. This attribute specifies after how many timeouts an automatic reconnect is tried.
- disable
stop communication with the device while this attribute is set to 1. For Modbus over TCP this also closes the TCP connection.

### ModbusSET

ModbusSET uses the low level Modbus module to provide a way to communicate with Silent 10 heat pumps from SET. It probably works with other heat pumps from SET as well and since the control device used in these heat pumps is an iChill IC121 from Dixell, it could even work for other heat pumps with this controller as well or with few changes. It defines the modbus holding registers for the temperature sensors and reads them in a defined interval.
Prerequisites

- This module requires the basic Modbus module which itsef requires Device::SerialPort or Win32::SerialPort module.

Define

`define <name> ModbusSET <Id> <Interval>`
The module connects to the heat pump with Modbus Id <Id> through an already defined modbus device and actively requests data from the heat pump every <Interval> seconds
Example:

`define WP ModbusSET 1 60`

Configuration of the module

apart from the modbus id and the interval which both are specified in the define command there is nothing that needs to be defined. However there are some attributes that can optionally be used to modify the behavior of the module.
The attributes that control which messages are sent / which data is requested every <Interval> seconds are:

            poll-Hyst_Mode
            poll-Temp_Luft
            poll-Temp_Wasser_Aus_Off
            poll-Temp_Wasser_Ein_Off
            poll-Temp_Wasser_Aus
            poll-Hysterese
            poll-Temp_Wasser_Ein
            poll-Temp_Soll
            poll-Temp_Luft_Off
            poll-Temp_Verdampfer
            poll-Temp_Verdampfer_Off

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 the temperatures are requested if no attributes are set.
if some readings should be polled, but less frequently than the normal interval, you can specify a pollDelay- Attribute for the reading.
The pollDelay attribute allows to poll objects at a lower rate than the interval specified in the define command. you can either specify a time in seconds or number prefixed by "x" which means a multiple of the interval of the define command.
if you specify a normal numer then it is interpreted as minimal time between the last read and another automatic read. Please note that this does not create an individual interval timer. Instead the normal interval timer defined by the interval of the define command will check if this reading is due or not yet. So the effective interval will always be a multiple of the interval of the define.
Example:

            define WP ModbusSET 1 60
            attr WP poll-Temp_Soll 0
            attr WP pollDelay-Hysterese 300

Set-Commands

The following set options are available:

            Hysterese (defines the hysterese in Kelvin)
            Hyst_Mode (defines the interpretation of hysterese for the heating and can be set to mittig, oberhalb or unterhalb)
            Temp_Wasser_Aus_Off (offset of sensor in Kelvin - used to kalibrate)
            Temp_Wasser_Ein_Off (offset of sensor in Kelvin - used to kalibrate)
            Temp_Luft_Off (offset of sensor in Kelvin - used to kalibrate)
            Temp_Verdampfer_Off (offset of sensor in Kelvin - used to kalibrate)
            Temp_Soll (target temperature of the heating pump)

Get-Commands

All readings 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-Hyst_Mode
- poll-Temp_Luft
- poll-Temp_Wasser_Aus_Off
- poll-Temp_Wasser_Ein_Off
- poll-Temp_Wasser_Aus
- poll-Hysterese
- poll-Temp_Wasser_Ein
- poll-Temp_Soll
- poll-Temp_Luft_Off
- poll-Temp_Verdampfer
- poll-Temp_Verdampfer_Off
include a read request for the corresponding registers when sending requests every interval seconds
- pollDelay-*
set a delay for polling individual Readings. In case some readings should be polled less frequently than the normal delay specified during define. Specifying a pollDelay will not create an individual timer for polling this reading but check if the delay is over when the normal update interval is handled.
You can either specify a time in seconds or number prefixed by "x" which means a multiple of the interval of the define command.
If you specify a normal numer then it is interpreted as minimal time between the last read and another automatic read. Please note that this does not create an individual interval timer. Instead the normal interval timer defined by the interval of the define command will check if this reading is due or not yet. So the effective interval will always be a multiple of the interval of the define.
- dev-timing-timeout
set the timeout for reads, defaults to 2 seconds
- dev-timing-minSendDelay
minimal delay between two requests sent to this device
- dev-timing-minCommDelay
minimal delay between requests or receptions to/from this device

### ModbusTrovis5576

ModbusTrovis5576 uses the low level Modbus module to provide a way to communicate with the Samson Trovis 5576 Heating Management. It defines the modbus holding registers for the different values and reads them in a defined interval.
Prerequisites

This module requires the basic Modbus module which itsef requires Device::SerialPort or Win32::SerialPort module.

Hardware Connection

The Manual shows on page 124 a diagram of the correct pins for connecting to the serial port. The RS232-Port is not the one on the front side, but, as seen from the front, on the left side of the heating management. This port is covered with a small plastic-shield which can easily be removed.
Only the usual pins for serial communication (TD, RD and Ground) are needed.

Special meanings with Readings and the Heating Management System

If you change the value of "Betriebsart" ("Operating Mode") the rotary switch at the heating management doesn't change. To reflect this fact the display shows "GLT" (in German "Gebäudeleittechnik" - Building Control Center) and the corresponding so-called Ebenen-Bit ("_EBN" - Level-Bit) is set to "GLT".
If you want to switch back to autonomous mode you can set the appropriate Ebenen-Bit to "Autark".
If you change the value of "Betriebsart" to standby it could be happen that it is automatically (re-)changed to "Mond" ("Moon"). This happens if the outside temperature is lower than 3°C and it's shown with the value of "Frostschutzbetrieb" ("Frost Protection Mode").
Suggestion:
It is hardly recommended to set the Attribute `event-on-change-reading` to `.*`. Otherwise the system will generate many senseless events.

Define

`define <name> ModbusTrovis5576 <ID> <Interval>`
The module connects to the Samson Trovis 5576 Heating Management with the Modbus Id <ID> through an already defined Modbus device and actively requests data from the system every <Interval> seconds.
Example:
`define heizung ModbusTrovis5576 255 60`

Set-Commands

The following set options are available:

- Regelkreis 1 (Usually Wallmounted-Heatings):
  - RK1_Betriebsart: Operating mode of Regelkreis 1. Possible values are Standby, Mond or Sonne.
  - RK1_Betriebsart_EBN: The Ebenen-Bit according to the Operating Mode. Possible values are GLT or Autark.
  - RK1_Stellsignal: The percent value of opening of the heat transportation valve.
  - RK1_Stellsignal_EBN: The Ebenen-Bit according to the heat transportation valve. Possible values are GLT or Autark.
  - RK1_Umwaelzpumpe: The on/off state of thr circulation pump. Possible values are An or Aus.
  - RK1_Umwaelzpumpe_EBN: The Ebenen-Bit according to the circulation pump. Possible values are GLT or Autark.
- Regelkreis 2 (Usually Floor Heating System):
  - RK2_Betriebsart: Operating mode of Regelkreis 2. Possible values are Standby, Mond or Sonne.
  - RK2_Betriebsart_EBN: The Ebenen-Bit according to the Operating Mode. Possible values are GLT or Autark.
  - RK2_Stellsignal: The percent value of opening of the heat transportation valve.
  - RK2_Stellsignal_EBN: The Ebenen-Bit according to the heat transportation valve. Possible values are GLT or Autark.
  - RK2_Umwaelzpumpe: The on/off state of the circulation pump. Possible values are An or Aus.
  - RK2_Umwaelzpumpe_EBN: The Ebenen-Bit according to the circulation pump. Possible values are GLT or Autark.
- Drinkable Water Reservoir:
  - Wasser_Betriebsart: Operating mode of the drinkable water system. Possible values are Standby, Mond or Sonne.
  - Wasser_Betriebsart_EBN: The Ebenen-Bit according to the Operating Mode. Possible values are GLT or Autark.
  - Wasser_Speicherladepumpe: The on/off state of the reservoir loading pump. Possible values are An or Aus.
  - Wasser_Speicherladepumpe_EBN: The Ebenen-Bit according to the Speicherladepumpe. Possible values are GLT or Autark.
  - Wasser_ThermischeDesinfektion: On/off state of the thermal disinfection. Possible values are An or Aus.
  - Wasser_Temp_Soll: The desired temperature for the drinkabke water reservoir.
  - Wasser_Temp_Minimum: The lowest temperature for the drinkabke water reservoir.
  - Wasser_Temp_Desinfektion: The desired temperature of the thermal disinfection system.

All other Readings (along with there Meanings) which can only be read:

- Common Data:
  - Modellnummer: Shows the modelnumber. Should be "5576".
  - Aussen_Temp: Shows the currently measured outside temperature in °C.
- Regelkreis 1 (Usually Wallmounted-Heatings):
  - RK1_Schalter: Represent the current value of the rotary switch. Possible values are PA, Auto, Standby, Hand, Sonne or Mond.
  - RK1_Frostschutzbetrieb: On/off state of the frost protection mode of Regelkreis 1.
  - RK1_Vorlauf_Temp: Shows the currently measured flow temperature in °C of Regelkreis 1.
  - RK1_Ruecklauf_Temp: Shows the currently measured return temperature in °C of Regelkreis 1.
- Regelkreis 2 (Usually Floor Heating System):
  - RK2_Schalter: Represent the current value of the rotary switch. Possible values are PA, Auto, Standby, Hand, Sonne or Mond.
  - RK2_Frostschutzbetrieb: On/off state of the frost protection mode of Regelkreis 2.
  - RK2_Vorlauf_Temp: Shows the currently measured flow temperature in °C of Regelkreis 2.
  - RK2_Ruecklauf_Temp: Shows the currently measured return temperature in °C of Regelkreis 2.
- Drinkable Water Reservoir:
  - Wasser_Schalter: Represent the current value of the rotary switch. Possible values are PA, Auto, Standby, Hand, Sonne or Mond.
  - Wasser_Frostschutzbetrieb: On/off state of the frost protection mode of the drinkable water heating system.
  - Wasser_Temp: Shows the currently measured return temperature in °C of the drinkablr water reservoir.

Get-Commands

All readings 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 correct field value. This is a good way for getting a new current value from the Heating Management System.

Attribute

Only centralized Attributes are in use. Especially:

- readingFnAttributes

### N4HBUS

This module connects fhem to the net4home Bus. You need to define ojects with N4MODULE to set or read data of th net4home bus.
Further technical information can be found at the net4home.de Homepage
Define

`define <name> N4HBUS <device>`
<device> is a combination of <host>:<port>, where <host> is the IP address of the net4home Busconnector and <port> (default:3478).
Example:

`define net4home N4HBUS 192.168.1.69:3478`

The device can also be connected to the busconnector on the same machine.
Default Port for communication is 3478. In case you need to change this please change also the Port in the conf of busconnector service.

Readings

- state - current state of the Bus connection

Attributes

- MI - a unique MI in the net4home environment (default:65281)
- OBJADR - a unique OBJADR in the net4home environment (default:32700)

### N4HMODULE

fhem-Module to communicate with net4home modules via IP

Define

`define <name> N4HMODULE <device> <type> <objectaddress>`
Defines a net4home device connected to a N4HBUS device
Examples:

`define n4h_28204 N4HMODULE n4h 24 28204`

Currently the following values are supported:
Measurement

- 24 - Measurement,Temperature
- 25 - Measurement,Brightness
- 26 - Measurement,Humidity
- 240 - Measurement,Wind
- 242 - Measurement,Pressure
- 245 - Measurement,Rain

Readings

- The readings are dependent of the object of the net4home bus module.

Attributes

- interval
  the interval in seconds used to send values to bus.

### NUKIBridge

NUKIBridge - controls the Nuki Smartlock over the Nuki Bridge
The Nuki Bridge module connects FHEM to the Nuki Bridge and then reads all the smartlocks available on the bridge. Furthermore, the detected Smartlocks are automatically created as independent devices.
Define

`define <name> NUKIBridge <HOST> <API-TOKEN>`
Example:

`define NBridge1 NUKIBridge 192.168.0.23 F34HK6`

This statement creates a NUKIBridge device with the name NBridge1 and the IP 192.168.0.23 as well as the token F34HK6.
After the bridge device is created, all available Smartlocks are automatically placed in FHEM.

Readings

- 0_nukiId - ID of the first found Nuki Smartlock
- 0_name - Name of the first found Nuki Smartlock
- smartlockCount - number of all found Smartlocks
- bridgeAPI - API Version of bridge
- bridgeType - Hardware bridge / Software bridge
- currentTime - Current timestamp
- firmwareVersion - Version of the bridge firmware
- hardwareId - Hardware ID
- lastError - Last connected error
- serverConnected - Flag indicating whether or not the bridge is connected to the Nuki server
- serverId - Server ID
- uptime - Uptime of the bridge in seconds
- wifiFirmwareVersion- Version of the WiFi modules firmware
The preceding number is continuous, starts with 0 und returns the properties of one Smartlock.

Set

- autocreate - Prompts to re-read all Smartlocks from the bridge and if not already present in FHEM, create the autimatic.
- callbackRemove - Removes a previously added callback
- clearLog - Clears the log of the Bridge (only hardwarebridge)
- factoryReset - Performs a factory reset (only hardwarebridge)
- fwUpdate - Immediately checks for a new firmware update and installs it (only hardwarebridge)
- info - Returns all Smart Locks in range and some device information of the bridge itself
- reboot - reboots the bridge (only hardwarebridge)

Get

- callbackList - List of register url callbacks. The Bridge register up to 3 url callbacks.
- logFile - Retrieves the log of the Bridge

Attributes

- disable - disables the Nuki Bridge

### NUKIDevice

NUKIDevice - Controls the Nuki Smartlock
The Nuki module connects FHEM over the Nuki Bridge with a Nuki Smartlock. After that, it´s possible to lock and unlock the Smartlock.
Normally the Nuki devices are automatically created by the bridge module.
Define

`define <name> NUKIDevice <Nuki-Id> <IODev-Device>`
Example:

`define Frontdoor NUKIDevice 1 NBridge1`

This statement creates a NUKIDevice with the name Frontdoor, the NukiId 1 and the IODev device NBridge1.
After the device has been created, the current state of the Smartlock is automatically read from the bridge.

Readings

- state - Status of the Smartlock or error message if any error.
- lockState - current lock status uncalibrated, locked, unlocked, unlocked (lock ‘n’ go), unlatched, locking, unlocking, unlatching, motor blocked, undefined.
- name - name of the device
- paired - paired information false/true
- rssi - value of rssi
- succes - true, false Returns the status of the last closing command. Ok or not Ok.
- batteryCritical - Is the battery in a critical state? True, false
- battery - battery status, ok / low

Set

- statusRequest - retrieves the current state of the smartlock from the bridge.
- lock - lock
- unlock - unlock
- unlatch - unlock / open Door
- unpair - Removes the pairing with a given Smart Lock
- locknGo - lock when gone
- locknGoWithUnlatch - lock after the door has been opened

Attributes

- disable - disables the Nuki device
- webhookFWinstance - Webinstanz of the Callback
- webhookHttpHostname - IP or FQDN of the FHEM Server Callback

### NUT

The Network UPS Tools (www.networkupstools.org) provide support for Uninterruptable Power Supplies and the like. This module gives access to a running nut server. You can read data (status, runtime, input voltage, sometimes even temperature and so on). In the future it will also be possible to control the UPS (start test, switch off).
Which values you can use as readings is set with asReadings. Which values are available with this UPS, you can check with `list theUPS`. Only ups.status is always read and used as the status of the device.
Define

`define <name> NUT <ups> [<host>[:<port>]]`
<ups> is the name of a ups defined in the nut server.
[<host>[:<port>]] is the host of the nut server. If omitted, `localhost:3493` is used.
Example:
`define theUPS NUT myups otherserver`

Set

N/A

Get

N/A

Attributes

- disable
- readingFnAttributes
- pollState
  Polling interval in seconds for the state of the ups. Default: 10
- pollVal
  Polling interval in seconds of the other Readings. This should be a multiple of pollState. Default: 60
- asReadings
  Values of the UPS which are used as Readings (ups.status is read anyway)
  Example:
  `attr theUPS asReadings battery.charge,battery.runtime,input.voltage,ups.load,ups.power,ups.realpower`

### NetIO230B

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

Note: this module needs the HTTP::Request and LWP::UserAgent perl modules.
Please also note: the PDU must use firmware 3.1 or later and set to unencrypted mode.
Define

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

Defines a switching device, where sockets can be switched

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

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

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

`%config= (
host => "192.168.61.40",
user => "admin",
password => "admin"
);`
(All settings optional)

Examples:

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

Get

`get <name> state`
returns the state of the socket(s)
Example:

`get coffeemaker_and_light` => `on or off`

Set

`set <name> <value>`
where `value` is one of:

    		on
    		off

Examples:

`set coffeemaker_and_light on`

### Netzer

The Netzer realizes an Ethernet interface on a PIC-based platform. As a gateway module it enables communication between standard TCP/IP sockets and serial busses like I2C, SPI and UART. Also up to 13 GPIO pins can be accessed. This Modul provides access to these GPIO pins on a Netzer running IO_base in Version 1.5. There are two pins usable as ADC channel, two as PMW outputs, three as counter and three can generate an interrupt. The GPIO pins are configured a input per default. Before a port can be used as output it must be configured via the embedded webpage. If one of the input ports is configured to send interrupt events on GPIO Server, on every event all port values will be updated. All ports can be read and controlled individually by the function readingsProxy.
Define

`define <name> Netzer <host:port>`

Set

`set <name> <port[_counter]> <value>`
Where <value> is a character between `a` and `m`
according to the port. If Port attr is `cnt` an aditional value <port_counter> can be set.
Only ports with corresponding attr Port_[a-m] set to `PWM` or `out` can be used.
If Port attr is:

- PWM <value> can be a number between 0 and 1023
- out <value> can be a number between 0 and 1
- cnt <port_counter> <value> can be a number between 0 and 32767

Get

`get <name> [<port[_counter]>]`
If no <port> is set, all readings will be updated.
<port> is a character between `a` and `m`
according to the port. If Port attr is `cnt` an aditional reading <port_counter> can be read.

Attributes

- poll_interval
  Set the polling interval in minutes to query the sensor for new measured values. Default: 5, valid values: decimal number
- Port_<port>
  Configuration for Netzer port.
  <port> is a character between `a` and `m`.
  - `in`: Port is defined as input. Same behavior as no attribute. Set is not avaliable for this port.
    Can be used for all ports
  - `out`: Port is defined as output. Set is avaliable for this port with <value> between 0 and 1.
    Can be used for all ports
  - `cnt`: Port is defined as input. Set is not avaliable for this port.
    An second reading: Port_<port>_counter is avaiable. It can be updated with `get` an changed with `set`.
    Port_<port>_counter <value> = 0-32767 or overflow if outside this range.
    Can be used for ports a,b,c
  - `ADC`: Port is defined as analog input. `Get` <value> is 0-1023 according the voltage on port. Set is not avaliable for this port.
    Can be used for ports e,f
  - `PWM`: Port is defined as PWM output. `Set` and `get` <value> is 0-1023 according the duty cycle on the port.
    Can be used for ports d,j

### NetzerI2C

Provides access to Netzer's I2C interfaces for some logical modules and also directly.
preliminary:
Serial Server of Netzer must be activated and configured for I2C .
Define

`define <name> NetzerI2C <Device-Address:Port>`
where `<Device-Address:Port>` Device Address/ IP-Address and Serial Server TCP Port of the Netzer

Set

- Write one byte (or more bytes sequentially) directly to an I2C device (for devices that have only one register to write):
  `set <name> writeByte <I2C Address> <value>`
- Write one byte (or more bytes sequentially) to the specified register of an I2C device:
  `set <name> writeByteReg <I2C Address> <Register Address> <value>`
- Write n-bytes to an register range, beginning at the specified register:
  `set <name> writeBlock <I2C Address> <Register Address> <value>`
Examples:

Write 0xAA to device with I2C address 0x60
`set test1 writeByte 60 AA`
Write 0xAA to register 0x01 of device with I2C address 0x6E
`set test1 writeByteReg 6E 01 AA`
Write 0xAA to register 0x01 of device with I2C address 0x6E, after it write 0x55 to register 0x02
`set test1 writeByteReg 6E 01 AA 55`
Write 0xA4 to register 0x03, 0x00 to register 0x04 and 0xDA to register 0x05 of device with I2C address 0x60 as block operation
`set test1 writeBlock 60 03 A4 00 DA`

Get

`get <name> read <I2C Address> [<Register Address> [<number of registers>]]`
gets value of I2C device's registers
Examples:

Reads byte from device with I2C address 0x60
`get test1 writeByte 60`
Reads register 0x01 of device with I2C address 0x6E.
`get test1 read 6E 01 AA 55`
Reads register 0x03 to 0x06 of device with I2C address 0x60.
`get test1 read 60 03 4`

Attributes

- ignore
- do_not_notify
- showtime

### Nextion

This module connects remotely to a Nextion display that is connected through a ESP8266 or similar serial to network connection Nextion devices are relatively inexpensive tft touch displays, that include also a controller that can hold a user interface and communicates via serial protocol to the outside world.
A description of the Hardwarelayout for connecting the ESP8266 module and the Nextion Dispaly is in the correspdong forum thread https://forum.fhem.de/index.php/topic,51267.0.html.
Define

`define <name> Nextion <hostname/ip>:23`
Defines a Nextion device on the given hostname / ip and port (should be port 23/telnetport normally)
Example: `define nxt Nextion 10.0.0.1:23`

Set

`set <name> <what> [<value>]`
where <what> / <value> is one of
- `raw <nextion command>`
  Sends the given raw message to the nextion display. The supported commands are described with the Nextion displays: http://wiki.iteadstudio.com/Nextion_Instruction_Set
  Examples:
  `set nxt raw page 0`
    switch the display to page 0
  `set nxt raw b0.txt`
    get the text for button 0
- `cmd <nextion command>`
  same as raw
- `page <0 - 9>`
  set the page number given as new page on the nextion display.
- `pageCmd <one or multiple page numbers separated by ,> <cmds>`
  Execute the given commands if the current page on the screen is in the list given as page number.

Attributes

- `hasSendMe <0 or 1>`
  Specify if the display definition on the Nextion display is using the "send me" checkbox to send current page on page changes. This will then change the reading currentPage accordingly
- `initCommands <series of commands>`
  Display will be initialized with these commands when the connection to the device is established (or reconnected). Set logic for executing perl or getting readings can be used. Multiple commands will be separated by ;
  Example
  `t1.txt="Hallo";p1.val=1;`
- `initPage1 <series of commands>` to `initPage9 <series of commands>`
  When the corresponding page number will be displayed the given commands will be sent to the display. See also initCommands.
  Example
  `t1.txt="Hallo";p1.val=1;`
- `expectAnswer <1 or 0>`
  Specify if an answer from display is expected. If set to zero no answer is expected at any time on a command.

Readings

- `received <Hex values of the last received message from the display>`
  The message is converted in hex values (old messages are stored in the readings old1 ... old5). Example for a message is `H65(e) H00 H04 H00`
- `rectext <text or empty>`
  Translating the received message into text form if possible. Beside predefined data that is sent from the display on specific changes, custom values can be sent in the form `$name=value`. This can be sent by statements in the Nextion display event code
  `print "$bt0="
  get bt0.val`
- `currentPage <page number on the display>`
  Shows the number of the UI screen as configured on the Nextion display that is currently shown.
  This is only valid if the attribute `hasSendMe` is set to 1 and used also in the display definition of the Nextion.
- `cmdSent <cmd>`
  Last cmd sent to the Nextion Display
- `cmdResult <result text>`
  Result of the last cmd sent to the display (or empty)

### OBIS

This module is for SmartMeters, that report their data in OBIS-Standard. It dosen't matter, wether the data comes as PlainText or SML-encoded.
Define `define <name> OBIS device|none [MeterType]`
<device> specifies the serial port to communicate with the smartmeter. Normally on Linux the device will be named /dev/ttyUSBx, where x is a number. For example /dev/ttyUSB0. You may specify the baudrate used after the @ char.
Optional:MeterType can be of

- VSM102 -> Voltcraft VSM102
- E110 -> Landis&&;Gyr E110
- E350USB -> Landis&&;Gyr E350 USB-Version
- Standard -> Data comes as plainText
- SML -> Smart Message Language

Example:
`define myPowerMeter OBIS /dev/ttyPlugwise@@9600,7,E,1 VSM102`
Attributes

- `offset_feed
  offset_energy`
  If your smartmeter is BEHIND the meter of your powersupplier, then you can hereby adjust the total-reading of your SM to that of your official one.
- `channels`
  With this, you can rename the reported channels. `attr myOBIS channels {"1.0.96.5.5.255"=>"Status","1.0.0.0.0.255"=>"Info","16.7"=>"Verbrauch"}>`
- `directions`
  Some Meters report feeding/comnsuming of power in a statusword. If this is set, you get an extra reading dir_total_consumption which defaults to "in" and "out" Here, you can change this text with: `attr myOBIS directions {">" => "pwr consuming", "<"=>"pwr feeding"}`
- `interval`
  The polling-interval in seconds. (Only useful in Polling-Mode)
- `alignTime`
  Aligns the intervals to a given time. Each interval is repeatedly calculated. So if alignTime=00:00 and interval=600 aligns the interval to xx:00:00, xx:10:00, xx:20:00 etc.... `pollingMode`
  Changes from direct-read to polling-mode. Useful with meters, that send a continous datastream. Reduces CPU-load. `unitReadings`
  Adds the units to the readings like w, wH, A etc. `valueBracket`
  Sets, weather to use the value from the first or the second bracket, if applicable. Standard is "second"

### ONKYO_AVR

Define

`define <name> ONKYO_AVR <ip-address-or-hostname[:PORT]> [<protocol-version>]`
`define <name> ONKYO_AVR <devicename[@baudrate]> [<protocol-version>]`
This module controls ONKYO A/V receivers in real-time via network connection.
Some newer Pioneer A/V models seem to run ONKYO's ISCP protocol as well and therefore should be fully supported by this module.
Use ONKYO_AVR_ZONE to control slave zones.
Instead of IP address or hostname you may set a serial connection format for direct connectivity.
Example:

`define avr ONKYO_AVR 192.168.0.10
# With explicit port
define avr ONKYO_AVR 192.168.0.10:60128
# With explicit protocol version 2013 and later
define avr ONKYO_AVR 192.168.0.10 2013
# With protocol version prior 2013
define avr ONKYO_AVR 192.168.0.10 pre2013
# With protocol version prior 2013 and serial connection
define avr ONKYO_AVR /dev/ttyUSB1@9600 pre2013`

Set

`set <name> <command> [<parameter>]`
Currently, the following commands are defined:

- channel - set active network service (e.g. Spotify)
- currentTrackPosition - seek to specific time for current track
- input - switches between inputs
- inputDown - switches one input down
- inputUp - switches one input up
- mute on,off - controls volume mute
- muteT - toggle mute state
- next - skip track
- off - turns the device in standby mode
- on - powers on the device
- pause - pause current playback
- play - start playback
- power on,off - set power mode
- preset - switches between presets
- presetDown - switches one preset down
- presetUp - switches one preset up
- previous - back to previous track
- remoteControl Send specific remoteControl command to device
- repeat off,all,all-folder,one - set repeat setting
- repeatT - toggle repeat state
- shuffle off,on,on-album,on-folder - set shuffle setting
- shuffleT - toggle shuffle state
- sleep 1..90,off - sets auto-turnoff after X minutes
- stop - stop current playback
- toggle - switch between on and off
- volume 0...100 - set the volume level in percentage
- volumeUp - increases the volume level
- volumeDown - decreases the volume level

Other set commands may appear dynamically based on previously used "get avr remoteControl"-commands and resulting readings.
See "get avr remoteControl <Set-name> help" to get more information about possible readings and set values.

Get

`get <name> <what>`
Currently, the following commands are defined:

- createZone - creates a separate ONKYO_AVR_ZONE device for available zones of the device
- remoteControl - sends advanced remote control commands based on current zone; you may use "get avr remoteControl <Get-command> help" to see details about possible values and resulting readings. In Case the device does not support the command, just nothing happens as normally the device does not send any response. In case the command is temporarily not available you may see according feedback from the log file using attribute verbose=4.
- statusRequest - clears cached settings and re-reads device XML configurations

Generated Readings/Events:

- audin_* - Shows technical details about current audio input
- brand - Shows brand name of the device manufacturer
- channel - Shows current network service name when (e.g. streaming services like Spotify); part of FHEM-4-AV-Devices compatibility
- currentAlbum - Shows current Album information; part of FHEM-4-AV-Devices compatibility
- currentArtist - Shows current Artist information; part of FHEM-4-AV-Devices compatibility
- currentMedia - currently no in use
- currentTitle - Shows current Title information; part of FHEM-4-AV-Devices compatibility
- currentTrack* - Shows current track timer information; part of FHEM-4-AV-Devices compatibility
- deviceid - Shows device name as set in device settings
- deviceyear - Shows model device year
- firmwareversion - Shows current firmware version
- input - Shows currently used input; part of FHEM-4-AV-Devices compatibility
- mute - Reports the mute status of the device (can be "on" or "off")
- playStatus - Shows current network service playback status; part of FHEM-4-AV-Devices compatibility
- power - Reports the power status of the device (can be "on" or "off")
- presence - Reports the presence status of the receiver (can be "absent" or "present"). In case of an absent device, control is not possible.
- repeat - Shows current network service repeat status; part of FHEM-4-AV-Devices compatibility
- screen* - Experimental: Gives some information about text that is being shown via on-screen menu
- shuffle - Shows current network service shuffle status; part of FHEM-4-AV-Devices compatibility
- sleep - Reports current sleep state (can be "off" or shows timer in minutes)
- state - Reports current network connection status to the device
- stateAV - Zone status from user perspective combining readings presence, power, mute and playStatus to a useful overall status.
- volume - Reports current volume level of the receiver in percentage values (between 0 and 100 %)
- vidin_* - Shows technical details about current video input before image processing
- vidout_* - Shows technical details about current video output after image processing
- zones - Shows total available zones of device

Using remoteControl get-command might result in creating new readings in case the device sends any data.

### ONKYO_AVR_ZONE

Define

`define <name> ONKYO_AVR_ZONE [<zone-id>]`
This is a supplement module for ONKYO_AVR representing zones.
Example:

`define avr ONKYO_AVR_ZONE
# For zone2
define avr ONKYO_AVR_ZONE 2
# For zone3
define avr ONKYO_AVR_ZONE 3
# For zone4
define avr ONKYO_AVR_ZONE 4`

Set

`set <name> <command> [<parameter>]`
Currently, the following commands are defined:

- channel - set active network service (e.g. Spotify)
- input - switches between inputs
- inputDown - switches one input down
- inputUp - switches one input up
- mute on,off - controls volume mute
- muteT - toggle mute state
- next - skip track
- off - turns the device in standby mode
- on - powers on the device
- pause - pause current playback
- play - start playback
- power on,off - set power mode
- preset - switches between presets
- presetDown - switches one preset down
- presetUp - switches one preset up
- previous - back to previous track
- remoteControl Send specific remoteControl command to device
- repeat off,all,all-folder,one - set repeat setting
- repeatT - toggle repeat state
- shuffle off,on,on-album,on-folder - set shuffle setting
- shuffleT - toggle shuffle state
- sleep 1..90,off - sets auto-turnoff after X minutes
- stop - stop current playback
- toggle - switch between on and off
- volume 0...100 - set the volume level in percentage
- volumeUp - increases the volume level
- volumeDown - decreases the volume level

Other set commands may appear dynamically based on previously used "get avr remoteControl"-commands and resulting readings.
See "get avr remoteControl <Set-name> help" to get more information about possible readings and set values.

Get

`get <name> <what>`
Currently, the following commands are defined:

- createZone - creates a separate ONKYO_AVR_ZONE device for available zones of the device
- remoteControl - sends advanced remote control commands based on current zone; you may use "get avr remoteControl <Get-command> help" to see details about possible values and resulting readings. In Case the device does not support the command, just nothing happens as normally the device does not send any response. In case the command is temporarily not available you may see according feedback from the log file using attribute verbose=4.

Generated Readings/Events:

- channel - Shows current network service name when (e.g. streaming services like Spotify); part of FHEM-4-AV-Devices compatibility
- currentAlbum - Shows current Album information; part of FHEM-4-AV-Devices compatibility
- currentArtist - Shows current Artist information; part of FHEM-4-AV-Devices compatibility
- currentMedia - currently no in use
- currentTitle - Shows current Title information; part of FHEM-4-AV-Devices compatibility
- currentTrack* - Shows current track timer information; part of FHEM-4-AV-Devices compatibility
- input - Shows currently used input; part of FHEM-4-AV-Devices compatibility
- mute - Reports the mute status of the device (can be "on" or "off")
- playStatus - Shows current network service playback status; part of FHEM-4-AV-Devices compatibility
- power - Reports the power status of the device (can be "on" or "off")
- presence - Reports the presence status of the receiver (can be "absent" or "present"). In case of an absent device, control is not possible.
- repeat - Shows current network service repeat status; part of FHEM-4-AV-Devices compatibility
- shuffle - Shows current network service shuffle status; part of FHEM-4-AV-Devices compatibility
- state - Reports current network connection status to the device
- stateAV - Zone status from user perspective combining readings presence, power, mute and playStatus to a useful overall status.
- volume - Reports current volume level of the receiver in percentage values (between 0 and 100 %)

Using remoteControl get-command might result in creating new readings in case the device sends any data.

### OPENWEATHER

The module extracts weather data via the openweather API of www.wetter.com.
It requires a registration on this website to obtain the necessary parameters.
It uses the perl moduls HTTP::Request, LWP::UserAgent, HTML::Parse and Digest::MD5.
Define

`define <name> OPENWEATHER <project> <cityCode> <apiKey> [language]`
Example:
`define wetter OPENWEATHER projectx DE0001020 3c551bc20819c19ee88d`
To obtain the below parameter you have to create a new project on www.wetter.com.
- `<project>`
  Name of the 'openweather' project (create with a user account on wetter.com).
- `<cityCode>`
  Code of the location for which the forecast is requested. The code is part of the URL of the weather forecast page. For example DE0009042 in:
  http://www.wetter.com/wetter_aktuell/aktuelles_wetter/deutschland/rostock/DE0009042.html
- `<apiKey>`
  Secret key that is provided when the user creates a 'openweather' project on wetter.com.
- `[language]`
  Optional. Default language of weather description is German. Change with en to English or es to Spanish.
The function `OPENWEATHER_Html` creates a HTML code for a vertically arranged weather forecast.
Example:
`define MyForecast weblink htmlCode { OPENWEATHER_Html("MyWeather") }`

Set

- `set <name> update`
  The weather data are immediately polled from the website.

Get

- `get <name> apiResponse`
  Shows the response of the web site.

Attributes

- `disable <0 | 1>`
  Automatic update is stopped if set to 1.
- `INTERVAL <seconds>`
  Polling interval for weather data in seconds (default and smallest value is 3600 = 1 hour). 0 will stop automatic updates.
- readingFnAttributes

Forecast readings

Note! The forecast values (in brackets) have first to be selected on the project setup page on wetter.com.
- fc 0|1|2_... - forecast values for today|tommorrow|in 2 days
- fc 0_...06|11|17|23 - forecast values for today at 06|11|17|23 o'clock
- fc 1_temp Min|Max - minimal|maximal temperature for tommorrow in °C (tn,tx)
- fc 0_temp Min06 - minimal temperatur today at 06:00 o'clock in °C
- fc 0_chOfRain - chance of rain today in % (pc)
- fc 0_valHours 06 - validity period in hours of the forecast values starting at 06:00 o'clock (p)
- fc 0_weather - weather situation today in German (w_txt)
- fc 0_weatherCode - code of weather situation today (w)
- fc 0_wday - German abbreviation of week day of today (d)
- fc 0_wind - wind speed today in km/h (ws)
- fc 0_windDir - wind direction today in ° (degree) (wd)
- fc 0_windDirTxt - wind direction today in text form (wd_txt
- etc.

### OREGON

The OREGON module interprets Oregon sensor messages received by a RFXCOM or SIGNALduino or CUx receiver. You need to define a receiver (RFXCOM, SIGNALduino or CUx) first. See RFXCOM. See SIGNALduino.
Define

`define <name> OREGON <deviceid>`
<deviceid> is the device identifier of the Oregon sensor. It consists of the sensors name and a one byte hex string (00-ff) that identifies the sensor. The define statement with the deviceid is generated automatically by autocreate. The following sensor names are used: BTHR918, BTHR918N, PCR800 RGR918, RTGR328N, THN132N, THGR228N, THGR328N, THGR918, THR128, THWR288A, THGR810, UV138, UVN800, WGR918, WGR800, WTGR800_A, WTGR800_T.
The one byte hex string is generated by the Oregon sensor when is it powered on. The value seems to be randomly generated. This has the advantage that you may use more than one Oregon sensor of the same type even if it has no switch to set a sensor id. For exampple the author uses three BTHR918 sensors at the same time. All have different deviceids. The drawback is that the deviceid changes after changing batteries.
Example:
`define Kaminzimmer OREGON BTHR918N_ab`

Set

N/A

Get

N/A

Attributes

- IODev
- do_not_notify
- ignore
- showtime
- readingFnAttributes

### OWAD

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

#### Example

`define OWX_AD OWAD 724610000000 45`
`attr OWX_AD DAlarm high`
`attr OWX_AD DName humidity`
`attr OWX_AD DUnit %`
`attr OWX_AD DFunction VD*31.907097-0.8088`
`attr OWX_AD DHigh 50.0`

#### Define

`define <name> OWAD [<model>] <id> [<interval>]` or
`define <name> OWAD <fam>.<id> [<interval>]`
Define a 1-Wire A/D converter.

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

#### Set

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

#### Get

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

#### Attributes

- `attr <name> stateAL0 <string>`
  character string for denoting low normal condition, default is empty
- `attr <name> stateAH0 <string>`
  character string for denoting high normal condition, default is empty
- `attr <name> stateAL1 <string>`
  character string for denoting low alarm condition, default is ↓
- `attr <name> stateAH1 <string>`
  character string for denoting high alarm condition, default is ↑

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

- `attr <name> <channel>Name <string>[|<string>]`
  name for the channel [|short name used in state reading].
- `attr <name> <channel>Unit <string>`
  unit of measurement for this channel used in state reading (default "V", set to "none" for empty).
- `attr <name> <channel>Function <string>`
  arbitrary functional expression involving the variables VA,VB,VC,VD. VA is replaced by the (raw) measured voltage in channel A, etc. This attribute allows linearization of measurement curves as well as the mixing of various channels.
- `attr <name> <channel>Alarm <string>`
  alarm setting in this channel, either both, low, high or none (default).
- `attr <name> <channel>Low <float>`
  measurement value for low alarm.
- `attr <name> <channel>High <float>`
  measurement value for highalarm.
- readingFnAttributes

### OWCOUNT

FHEM module to commmunicate with 1-Wire Counter/RAM DS2423 or its emulation DS2423emu
This 1-Wire module works with the OWX interface module or with the OWServer interface module (prerequisite: Add this module's name to the list of clients in OWServer). Please define an OWX device or OWServer device first.

#### Example

`define OWC OWCOUNT 1D.CE780F000000 60`
`attr OWC AName energy|W`
`attr OWC AUnit kWh`
`attr OWC APeriod hour`
`attr OWC ARate power|P`
`attr OWX_AMode daily`

#### Define

`define <name> OWCOUNT [<model>] <id> [<interval>]` or
`define <name> OWCOUNT <fam>.<id> [<interval>]`
Define a 1-Wire counter.

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

#### Set

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

#### Get

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

#### Attributes

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

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

- `attr <name> <channel>Name <string>[|<string>]`
  name for the channel [|short name used in state reading].
- `attr <name> <channel>Unit <string&`
  unit of measurement used in state reading (default "cts", set to "none" for empty).
- `attr <name> <channel>Rate <string>[|<string>]`
  name for the channel rate [|short name used in state reading]
- `attr <name> <channel>Offset <float>`
  offset added to the reading in this channel.
- `attr <name> <channel>Factor <float>`
  factor multiplied to (reading+offset) in this channel.
- `attr <name> <channel>Mode daily | normal`
  determines whether counter is nulled at start of day or running continuously
- `attr <name> <channel>Period hour(default) | minute | second`
  period for rate calculation
- readingFnAttributes

### OWDevice

Define

`define <name> OWDevice <address> [<interval>]`
Defines a 1-wire device. The 1-wire device is identified by its <address>. It is served by the most recently defined OWServer.
If <interval> is given, the OWServer is polled every <interval> seconds for a subset of readings.
OWDevice is a generic device. Its characteristics are retrieved at the time of the device's definition. The available readings that you can get or set as well as those that are regularly retrieved by polling can be seen when issuing the `list <name>` command.
The following devices are currently supported:

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

Adding more devices is simple. Look at the code (subroutine `OWDevice_GetDetails`).
This module is completely unrelated to the 1-wire modules with names all in uppercase.
Note:The state reading never triggers events to avoid confusion.
Example:

`define myOWServer OWServer localhost:4304
get myOWServer devices
10.487653020800 DS18S20
define myT1 OWDevice 10.487653020800
list myT1 10.487653020800
Internals:
...
Readings:
2012-12-22 20:30:07 temperature 23.1875
Fhem:
...
getters:
address
family
id
power
type
temperature
templow
temphigh
polls:
temperature
setters:
alias
templow
temphigh
...
`

Set

- `set <name> interval <value>`
  `value` modifies the interval for polling data. The unit is in seconds.
- `set <name> <reading> <value>`
  Sets <reading> to <value> for the 1-wire device <name>. The permitted values are defined by the underlying 1-wire device type.
  Example:
  `set myT1 templow 5`

Get

`get <name> <reading> <value>`
Gets <reading> for the 1-wire device <name>. The permitted values are defined by the underlying 1-wire device type.
Example:

`get myT1 temperature`

Attributes

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

### OWFS

OWFS is a suite of programs that designed to make the 1-wire bus and its devices easily accessible. The underlying priciple is to create a virtual filesystem, with the unique ID being the directory, and the individual properties of the device are represented as simple files that can be read and written.
Note: You need the owperl module from http://owfs.org/.
Define

`define <name> OWFS <owserver-ip:port> <model> [<id>]`
Define a 1-wire device to communicate with an OWFS-Server.
`<owserver-ip:port>`

IP-address:port from OW-Server.

`<model>`

Define the type of the input device. Currently supportet: `DS1420, DS9097 (for passive Adapter)`

`<id>`

Corresponding to the id of the input device. Only for active Adapter.

Note:
If the `owserver-ip:port` is called `none`, then no device will be opened, so you can experiment without hardware attached.
Example:

`#define an active Adapter:
define DS9490R OWFS 127.0.0.1:4304 DS1420 93302D000000`

`#define a passive Adapter:
define DS9097 OWFS 127.0.0.1:4304 DS9097`

Set

N/A

Get

`get <name> <value>`
where `value` is one of (not supported by passive Devices e.g. DS9097):

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

Examples:

`get DS9490R type`
`DS9490R type => DS1420`
`get DS9490R address`
`DS9490R address => 8193302D0000002B`

Attributes

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

### OWID

FHEM module for 1-Wire devices that know only their unique ROM ID
This 1-Wire module works with the OWX interface module or with the OWServer interface module Please define an OWX device or OWServer device first.

#### Example

`define ROM1 OWX_ID OWCOUNT 09.CE780F000000 10`

#### Define

`define <name> OWID <fam> <id> [<interval>]` or
`define <name> OWID <fam>.<id> [<interval>]`
Define a 1-Wire device.

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

#### Set

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

#### Get

- `get <name> id`
  Returns the full 1-Wire device id OW_FAMILY.ROM_ID.CRC
- `get <name> present`
  Returns 1 if this 1-Wire device is present, otherwise 0.

#### Attributes

- readingFnAttributes

### OWLCD

FHEM module to commmunicate with the 1-Wire LCD controller from Louis Swart (1-Wire family id FF). See also the corresponding Wiki page.
Note:
This 1-Wire module so far works only with the OWX interface module. Please define an OWX device first.

#### Example

`define OWX_LCD OWLCD 9F0700000100`

#### Define

`define <name> OWLCD <id>` or
`define <name> OWLCD FF.<id>`
Define a 1-Wire LCD device.

- `<id>`
  12-character unique ROM id of the converter device without family id and CRC code

#### Set

- `set <name> icon <int> on|off|blink`
  Set one of the icons 0..14 on, off or blinking
- `set <name> icon 15 0..6`
  Set icon 15 to one of its values
- `set <name> icon none`
  Set all icons off
- `set <name> line <int> <string>`
  Write LCD line 0..3 with some content
- `set <name> memory <page> <string>`
  Write memory page 0..6
- `set <name> gpio <value>`
  Write state for all three gpio pins (value = 0..7, for each bit 0=ON, 1=OFF)
- `set <name> backlight ON|OFF`
  Switch backlight on or off
- `set <name> lcd ON|OFF`
  Switch LCD power on or off
- `set <name> reset`
  Reset the display
- `set <name> test`
  Test the display

#### Get

- `get <name> id`
  Returns the full 1-Wire device id OW_FAMILY.ROM_ID.CRC
- `get <name> present`
  Returns 1 if this 1-Wire device is present, otherwise 0.
- `get <name> memory <page>`
  Read memory page 0..6
- `get <name> gpio`
  Obtain state of all four input channels (15 = all off, 0 = all on)
- `get <name> counter`
  Obtain state of all four input counters (4 x 16 Bit)
- `get <name> version`
  Obtain firmware version of the controller

#### Attributes

- `attr <name> lcdgeometry <string>`
  LCD geometry, values are 0-32-64-96 (default) or 0-64-20-84
- `attr <name> lcdcontroller <string>`
  LCD geometry, values are KS0073 (default) HD44780
- readingFnAttributes

### OWMULTI

FHEM module to commmunicate with 1-Wire multi-sensors, currently the DS2438 smart battery monitor
This 1-Wire module works with the OWX interface module or with the OWServer interface module (prerequisite: Add this module's name to the list of clients in OWServer). Please define an OWX device or OWServer device first.

#### Example

`define OWX_M OWMULTI 7C5034010000 45`
`attr OWX_M VName humidity|rH`
`attr OWX_M VUnit %`
`attr OWX_M VFunction (161.29 * V / VDD - 25.8065)/(1.0546 - 0.00216 * T)`

#### Define

`define <name> OWMULTI [<model>] <id> [<interval>]` or
`define <name> OWMULTI <fam>.<id> [<interval>]`
Define a 1-Wire multi-sensor

- `[<model>]`
  Defines the sensor model (and thus 1-Wire family id), currently the following values are permitted:
  - model DS2438 with family id 26 (default if the model parameter is omitted). Measured is a temperature value, an external voltage and the current supply voltage
- `<fam>`
  2-character unique family id, see above
- `<id>`
  12-character unique ROM id of the converter device without family id and CRC code
- `<interval>`
  Measurement interval in seconds. The default is 300 seconds.

#### Set

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

#### Get

- `get <name> id`
  Returns the full 1-Wire device id OW_FAMILY.ROM_ID.CRC
- `get <name> present`
  Returns 1 if this 1-Wire device is present, otherwise 0.
- `get <name> interval`
  Returns measurement interval in seconds.
- `get <name> reading`
  Obtain all three measurement values.
- `get <name> temperature`
  Obtain the temperature value.
- `get <name> VDD`
  Obtain the current supply voltage.
- `get <name> raw`
  Obtain the raw readings for V and W.

#### Attributes

- `attr <name> VName <string>[|<string>]`
  name for the voltage channel [|short name used in state reading].
- `attr <name> VUnit <string>`
  unit of measurement for the voltage channel used in state reading (default "V", set to "none" for empty).
- `attr <name> VFunction <string>`
  arbitrary functional expression involving the values VDD, V, W and T. Example see above.
  - VDD is replaced by the measured supply voltage in Volt,
  - V by the measured external voltage channel,
  - W by the measured external sense channel,
  - T by the measured and corrected temperature in its unit
- `attr <name> WName <string>[|<string>]`
  name for the sense channel [|short name used in state reading].
- `attr <name> WUnit <string>`
  unit of measurement for the sense channel used in state reading (default “V", set to "none" for empty).
- `attr <name> WFunction <string>`
  arbitrary functional expression involving the values VDD, V, W and T. Example and usage see above.
- `attr <name> tempOffset <float>`
  temperature offset in °C added to the raw temperature reading.
- `attr <name> tempUnit Celsius|Kelvin|Fahrenheit`
  unit of measurement (temperature scale), default is Celsius = °C
- readingFnAttributes

### OWSWITCH

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

#### Example

`define OWX_S OWSWITCH DS2413 B5D502000000 60`
`attr OWX_S AName light-a|la`
`attr OWX_S AUnit AN|AUS`

#### Define

`define <name> OWSWITCH [<model>] <id> [<interval>]` or
`define <name> OWSWITCH <fam>.<id> [<interval>]`
Define a 1-Wire switch.

- `[<model>]`
  Defines the switch model (and thus 1-Wire family id), currently the following values are permitted:
  - model DS2413 with family id 3A (default if the model parameter is omitted). 2 Channel switch with onboard memory
  - model DS2406 with family id 12. 2 Channel switch
  - model DS2408 with family id 29. 8 Channel switch
- `<fam>`
  2-character unique family id, see above
- `<id>`
  12-character unique ROM id of the device without family id and CRC code
- `<interval>`
  Measurement interval in seconds. The default is 300 seconds.

#### Set

- `set <name> interval <int>`
  Measurement interval in seconds. The default is 300 seconds.
- `set <name> output <channel-name> on | off | on-for-timer <time> | off-for-timer <time>`
  Set value for channel (A,B,... or defined channel name). 1 = off, 0 = on in normal usage. See also the note above.
  on-for-timer/off-for-timer will set the desired value only for the given time, either given as hh:mm:ss or as integers seconds and then will return to the opposite value.
- `set <name> gpio <value>`
  Set values for channels (For 2 channels: 3 = A and B off, 1 = B on 2 = A on 0 = both on)
- `set <name> init yes`
  Re-initialize the device

#### Get

- `get <name> id`
  Returns the full 1-Wire device id OW_FAMILY.ROM_ID.CRC
- `get <name> present`
  Returns 1 if this 1-Wire device is present, otherwise 0.
- `get <name> interval`
  Measurement interval in seconds.
- `get <name> input <channel-name>`
  state for channel (A,B, ... or defined channel name) This value reflects the measured value, not necessarily the one set as output state, because the output transistors are open collector switches. A measured state of 1 = OFF therefore corresponds to an output state of 1 = OFF, but a measured state of 0 = ON can also be due to an external shortening of the output, it will be signaled by appending the value of the attribute stateS to the reading.
- `get <name> gpio`
  Obtain state of all channels

#### Attributes

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

- `<name> stateS <string>`
  character string denoting external shortening condition (default is X, set to "none" for empty).
- `attr <name> <channel>Name <string>[|<string>]`
  name for the channel [|short name used in state reading]
- `attr <name> <channel>Unit <string>|<string>`
  display for on | off condition
- readingFnAttributes

### OWServer

Define

`define <name> OWServer <protocol>`
Defines a logical OWServer device. OWServer is the server component of the 1-Wire Filesystem. It serves as abstraction layer for any 1-wire devices on a host. <protocol> has format <hostname>:<port>. For details see owserver documentation.

You need OWNet.pm from owfs.org on Sourceforge, which is normally deployed with FHEM. As at 2012-12-23 the OWNet module on CPAN has an issue which renders it useless for remote connections.

The ow* version 2.9 packages provided with Debian Jessie in combination with OWNet.pm as deployed with FHEM have issues. For Debian Jessie please either unzip owfs_2.8p17-1_all.zip and install owserver, dependencies and what else you require with `dpkg -i <package>.deb` or use the latest OWNet.pm from Sourceforge.

A typical working configuration file `/etc/owfs.conf` looks as follows:

`# server uses device /dev/onewire
server: device = /dev/onewire
# clients other than server use server
! server: server = localhost:4304
# port
server: port = 4304
# owhttpd
http: port = 2121
# owftpd
ftp: port = 2120
`

The actual 1-wire devices are defined as OWDevice devices. If autocreate is enabled, all the devices found are created at start of FHEM automatically.
This module is completely unrelated to the 1-wire modules with names all in uppercase.
Examples:

`define myLocalOWServer OWServer localhost:4304`
`define myRemoteOWServer OWServer raspi:4304`

Notice: if you get no devices add both `localhost` and the FQDN of your owserver as server directives to the owserver configuration file on the remote host.

Set

`set <name> <value>`
where `value` is one of
- `reopen`
  Reopens the connection to the owserver.
- owserver (OWFS) specific settings:
  - `timeout/directory`
  - `timeout/ftp`
  - `timeout/ha7`
  - `timeout/network`
  - `timeout/presence`
  - `timeout/serial`
  - `timeout/server`
  - `timeout/stable`
  - `timeout/uncached`
  - `timeout/usb`
  - `timeout/volatile`
  - `timeout/w1`
  - `units/pressure_scale`
  - `units/temperature_scale`
For further informations have look on owserver manual).

Get

`get <name> <value>`
where `value` is one of
- `devices`
  Lists the addresses and types of all 1-wire devices provided by the owserver. Also shows the corresponding OWDevice if one is defined for the respective 1-wire devices.
- `errors`
  List a view of error statistics.
- owserver (OWFS) specific settings:
  - `/settings/timeout/directory`
  - `/settings/timeout/ftp`
  - `/settings/timeout/ha7`
  - `/settings/timeout/network`
  - `/settings/timeout/presence`
  - `/settings/timeout/serial`
  - `/settings/timeout/server`
  - `/settings/timeout/stable`
  - `/settings/timeout/uncached`
  - `/settings/timeout/usb`
  - `/settings/timeout/volatile`
  - `/settings/timeout/w1`
  - `/settings/units/pressure_scale`
  - `/settings/units/temperature_scale`
For further informations have look on owserver manual).

Attributes

- nonblocking
  Get all readings (OWServer / OWDevice) via a child process. This ensures, that FHEM is not blocked during communicating with the owserver.
  Example:
  `attr <name> nonblocking 1`
- eventMap
- readingFnAttributes

Note: unset `nonblocking` if you experience lockups of FHEM.

### OWTEMP

High-Precision 1-Wire Digital Thermometer.
Note:
Please define an OWFS device first.
Define

`define <name> OWTEMP <id> [<interval>] [<alarminterval>]`
Define a 1-wire Digital Thermometer device.
`<id>`

Corresponding to the id of the input device.
Set <id> to `none`for demo mode.

`<interval>`

Sets the status polling intervall in seconds to the given value. The default is 300 seconds.

`<alarminterval>`

Sets the alarm polling intervall in seconds to the given value. The default is 300 seconds.

Note:
Currently supported type: `DS18S20`.
Example:

`define KG.hz.TF.01 OWTEMP 14B598010800 300 60`

Set

`set <name> <value>`
where `value` is one of:

- `templow` (read-write)
  The upper limit for the low temperature alarm state.
- `temphigh` (read-write)
  The lower limit for the high temperature alarm state.
- `ALARMINT` (write-only)
  Sets the alarm polling intervall in seconds to the given value.
- `INTERVAL` (write-only)
  Sets the status polling intervall in seconds to the given value.

Get

`get <name> <value>`
where `value` is one of:

- address (read-only)
- crc8 (read-only)
- family (read-only)
- id (read-only)
- locator (read-only)
- present (read-only)
- `temperature` (read-only)
  Read by the chip at high resolution (~12 bits). Units are selected from the defined OWFS Device. See temp-scale for choices.
- templow (read-write)
- temphigh (read-write)
- type (read-only)

Examples:

`get KG.hz.TF.01 type`
`KG.hz.TF.01 type => DS18S20`
`get KG.hz.TF.01 temperature`
`KG.hz.TF.01 temperature => 38.2500 (Celsius)`

Attributes

- do_not_notify
- loglevel
- showtime
- IODev

### OWTHERM

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

#### Example

`define OWX_T OWTHERM DS18B20 E8D09B030000 300`
`attr OWX_T tempUnit Kelvin`

#### Define

`define <name> OWTHERM [<model>] <id> [<interval>]` or
`define <name> OWTHERM <fam>.<id> [<interval>]`
Define a 1-Wire digital thermometer device.

- `[<model>]`
  Defines the thermometer model (and thus 1-Wire family id) currently the following values are permitted:
  - model DS1820 with family id 10 (default if the model parameter is omitted)
  - model DS1822 with family id 22
  - model DS18B20 with family id 28
- `<fam>`
  2-character unique family id, see above
- `<id>`
  12-character unique ROM id of the thermometer device without family id and CRC code
- `<interval>`
  Temperature measurement interval in seconds. The default is 300 seconds.

#### Set

- `set <name> interval <int>`
  Temperature readout interval in seconds. The default is 300 seconds. Attention:This is the readout interval. Whether an actual temperature measurement is performed, is determined by the tempConv attribute
- `set <name> tempHigh <float>`
  The high alarm temperature (on the temperature scale chosen by the attribute value)
- `set <name> tempLow <float>`
  The low alarm temperature (on the temperature scale chosen by the attribute value)

#### Get

- `get <name> id`
  Returns the full 1-Wire device id OW_FAMILY.ROM_ID.CRC
- `get <name> present`
  Returns 1 if this 1-Wire device is present, otherwise 0.
- `get <name> interval`
  Returns temperature measurement interval in seconds.
- `get <name> temperature`
  Obtain the temperature.
- `get <name> alarm`
  Obtain the alarm temperature values.

#### Attributes

- `attr <name> stateAL <string>`
  character string for denoting low alarm condition, default is ↓
- `attr <name> stateAH <string>`
  character string for denoting high alarm condition, default is ↑
- `attr <name> tempConv onkick|onread`
  determines, whether a temperature measurement will happen when "kicked" through the OWX backend module (all temperature sensors at the same time), or on reading the sensor (1 second waiting time, default).
- `attr <name> tempOffset <float>`
  temperature offset in °C added to the raw temperature reading.
- `attr <name> tempUnit none|Celsius|Kelvin|Fahrenheit`
  unit of measurement (temperature scale) for state reading (default is Celsius = °C, use "none" for empty).
- `attr <name> resolution 9|10|11|12`
  Temperature resolution in bit, only relevant for DS18B20
- `attr <name> interval <int>`
  Temperature readout interval in seconds. The default is 300 seconds. Attention:This is the readout interval. Whether an actual temperature measurement is performed, is determined by the tempConv attribute
- `attr <name> tempHigh <float>`
  high alarm temperature (on the temperature scale chosen by the attribute value).
- `attr <name> tempLow <float>`
  low alarm temperature (on the temperature scale chosen by the attribute value).
- readingFnAttributes

### OWVAR

FHEM module to commmunicate with 1-Wire bus digital potentiometer devices of type DS2890
This 1-Wire module works with the OWX interface module, but not yet with the OWServer interface module.

#### Example

`define OWX_P OWVAR E8D09B030000`
`attr OWX_P Function 1.02 * V + 0.58 | (U-0.58) / 1.02`

#### Define

`define <name> OWVAR <id>` or
`define <name> OWVAR <fam>.<id>`
Define a 1-Wire digital potentiometer device.

- `<fam>`
  2-character unique family id, must be 2C
- `<id>`
  12-character unique ROM id of the thermometer device without family id and CRC code

#### Set

- `set <name> value <float>`
  The value of the potentiometer resistance against ground. Arguments may be in the range of [0,100] without a Function attribute, or in the range needed for a Function

#### Get

- `get <name> id`
  Returns the full 1-Wire device id OW_FAMILY.ROM_ID.CRC
- `get <name> present`
  Returns 1 if this 1-Wire device is present, otherwise 0.
- `get <name> value`
  Obtain the value.

#### Attributes

- `attr <name> Name <string>[|<string>]`
  name for the reading [|name used in state reading].
- `attr <name> Unit <string>[|<string>]`
  unit of measurement used in state reading.
- `attr <name> Function <string>|<string>`
  The first string is an arbitrary functional expression u(V) involving the variable V. V is replaced by the raw potentiometer reading (in the range of [0,100]). The second string must be the inverse function v(U) involving the variable U, such that U can be replaced by the value given in the Set argument. Care has to taken that v(U) is in the range [0,100]. No check on the validity of these functions is performed, singularities may crash FHEM. Example see above.
- readingFnAttributes

### OWX

FHEM module to commmunicate with 1-Wire bus devices

- via an active DS2480/DS2482/DS2490/DS9097U bus master interface attached to an USB port or
- via a passive DS9097 interface attached to an USB port or
- via a network-attached CUNO or through a COC on the RaspBerry Pi
- via an Arduino running OneWireFirmata attached to USB

Internally these interfaces are vastly different, read the corresponding Wiki pages

#### Example

`define OWio1 OWX /dev/ttyUSB1`
`define OWio2 OWX COC`
`define OWio3 OWX 10`

#### Define

`define <name> OWX <serial-device>` or
`define <name> OWX <cuno/coc-device>` or
`define <name> OWX <arduino-pin>`
Define a 1-Wire interface to communicate with a 1-Wire bus.

- `<serial-device>` The serial device (e.g. USB port) to which the 1-Wire bus is attached.
- `<cuno-device>` The previously defined CUNO to which the 1-Wire bus is attached.
- `<arduino-pin>` The pin of the previous defined FRM to which the 1-Wire bus is attached. If there is more than one FRM device defined use IODev attribute to select which FRM device to use.

#### Set

- `set <name> interval <value>`
  sets the time period in seconds for "kicking" the 1-Wire bus (default is 300 seconds). This means:
  - With 1-Wire bus interfaces that do not supply power to the 1-Wire bus (attr buspower parasitic), the 1-Wire bus is reset at these intervals.
  - With 1-Wire bus interfaces that supply power to the 1-Wire bus (attr buspower = real), all temperature measurement devices on the bus receive the command to start a temperature conversion (saves a lot of time when reading)
  - With 1-Wire bus interfaces that contain a busmaster chip, the response to a reset pulse contains information about alarms.
- `set <name> followAlarms on|off`
  instructs the module to start an alarm search in case a reset pulse discovers any 1-Wire device which has the alarm flag set.

#### Get

- `get <name> alarms`
  performs an "alarm search" for devices on the 1-Wire bus and, if found, generates an event in the log (not with CUNO).
- `get <name> devices`
  redicovers all devices on the 1-Wire bus. If a device found has a previous definition, this is automatically used. If a device is found but has no definition, it is autocreated. If a defined device is not on the 1-Wire bus, it is autodeleted.

#### Attributes

- `attr <name> buspower real|parasitic`
  tells FHEM whether power is supplied to the 1-Wire bus or not.
- `attr <name> IODev`
  assignes a specific FRM-device to OWX. Required only if there is more than one FRM defined.
- Standard attributes alias, comment, event-on-update-reading, event-on-change-reading, room, eventMap, loglevel, webCmd

### OWX_ASYNC

FHEM module to commmunicate with 1-Wire bus devices

- via an active DS2480 bus master interface attached to an USB port or
- via an Arduino running ConfigurableFirmata attached to USB
- via an Arduino running ConfigurableFirmata connecting to FHEM via Ethernet

Internally these interfaces are vastly different, read the corresponding Wiki pages

OWX_ASYNC does pretty much the same job as OWX does, but using an asynchronous mode of communication

#### Example

`define OWio1 OWX_ASYNC /dev/ttyUSB1`
`define OWio3 OWX_ASYNC 10`

#### Define

`define <name> OWX_ASYNC <serial-device>` or
`define <name> OWX_ASYNC <cuno/coc-device>` or
`define <name> OWX_ASYNC <arduino-pin>`
Define a 1-Wire interface to communicate with a 1-Wire bus.

- `<serial-device>` The serial device (e.g. USB port) to which the 1-Wire bus is attached.
- `<cuno-device>` The previously defined CUNO to which the 1-Wire bus is attached.
- `<arduino-pin>` The pin of the previous defined FRM to which the 1-Wire bus is attached. If there is more than one FRM device defined use IODev attribute to select which FRM device to use.

#### Set

- `set <name> interval <value>`
  sets the time period in seconds for "kicking" the 1-Wire bus when the dokick attribute is set (default is 300 seconds).
- `set <name> followAlarms on|off`
  instructs the module to start an alarm search in case a reset pulse discovers any 1-Wire device which has the alarm flag set.

#### Get

- `get <name> alarms`
  performs an "alarm search" for devices on the 1-Wire bus and, if found, generates an event in the log (not with CUNO).
- `get <name> devices`
  redicovers all devices on the 1-Wire bus. If a device found has a previous definition, this is automatically used. If a device is found but has no definition, it is autocreated. If a defined device is not on the 1-Wire bus, it is autodeleted.

#### Attributes

- `attr <name> dokick 0|1`
  1 if the interface regularly kicks thermometers on the bus to do a temperature conversion, and to perform an alarm check, 0 if not
- `attr <name> buspower real|parasitic`
  parasitic if there are any devices on the bus that steal power from the data line.
  Ensures that never more than a single device on the bus is talked to (throughput is throttled noticable!)
  Automatically disables attribute 'dokick'.
- `attr <name> IODev <FRM-device>`
  assignes a specific FRM-device to OWX_ASYNC when working through an Arduino.
  Required only if there is more than one FRM defined.
- `attr <name> maxtimeouts <number>`
  maximum number of timeouts (in a row) before OWX_ASYNC disconnects itself from the busmaster and tries to establish a new connection
- Standard attributes alias, comment, event-on-update-reading, event-on-change-reading, room, eventMap, webCmd

### PCA301

The PCA301 is a RF controlled AC mains plug with integrated power meter functionality from ELV.
It can be integrated in to FHEM via a JeeLink as the IODevice.
The JeeNode sketch required for this module can be found in .../contrib/arduino/36_PCA301-pcaSerial.zip.
Define

`define <name> PCA301 <addr> <channel>`
addr is a 6 digit hex number to identify the PCA301 device. channel is a 2 digit hex number to identify the PCA301 device.
Note: devices are autocreated on reception of the first message.

Set

- on
- off
- identify
  Blink the status led for ~5 seconds.
- reset
  Reset consumption counters
- statusRequest
  Request device status update.
- set extensions are supported.

Get

Readings

- power
- consumption
- consumptionTotal
  will be created as a default user reading to have a continous consumption value that is not influenced by the regualar reset or overflow of the normal consumption reading

Attributes

- forceOn
  try to switch on the device whenever an off status is received.
- offLevel
  a power level less or equal `offLevel` is considered to be off. used only in conjunction with readonly.
- readonly
  if set to a value != 0 all switching commands (on, off, toggle, ...) will be disabled.
- ignore
  1 -> ignore this device.

### PHILIPS_AUDIO

Define

`define <name> PHILIPS_AUDIO <device model> <ip-address> [<status_interval>]
define <name> PHILIPS_AUDIO <device model> [<off_status_interval>] [<on_status_interval>]`
This module controls a Philips Audio Player e.g. MCi, Streamium or Fidelio and (potentially) any other device including a navigation server.
To check, open the following URL in the browser: http://[ip # of your device]:8889/index
(So far tested on: AW9000, NP3500, NP3700 and NP3900)
Currently implemented features:

- Power on/off
- Internet Radio Preset Selection
- Input selection
- Volume +/-
- Mute on/off
- ...

Defining a PHILIPS_AUDIO device will schedule an internal task (interval can be set with optional parameters <off_status_interval> and <on_status_interval> in seconds.
<off_status_interval> is a parameter used in case the device is powered off or not available.
<on_status_interval> is a parameter used in case the device is powered on.
If both parameters are unset, a default value 30 (seconds) for both is used.
If <off_status_interval> is set only the same value is used for both parameters.
Due to a relatively low-performance of the devices the minimum interval is set to 3 seconds.
The internal task periodically reads the status of the Network Player (power state, volume and mute status etc.) and triggers notify/filelog commands.
Example:

Add the following code into the fhem.cfg configuration file and restart fhem:
`define PHAUDIO_player PHILIPS_AUDIO NP3900 192.168.0.15
attr PHAUDIO_player webCmd input:volume:mute:inetRadioPreset
# With custom status interval of 60 seconds
define PHAUDIO_player PHILIPS_AUDIO NP3900 192.168.0.15 60
attr PHAUDIO_player webCmd input:volume:mute:inetRadioPreset
# With custom "off"-interval of 60 seconds and "on"-interval of 10 seconds
define PHAUDIO_player PHILIPS_AUDIO NP3900 192.168.0.15 60 10
attr PHAUDIO_player webCmd input:volume:mute:inetRadioPreset
`

Set

`set <name> <command> [<parameter>]`
Currently, the following commands are defined.
Note: Commands and parameters are case sensitive.

Available commands:
- aux - Switches to the AUX input (MP3 Link or similar).
- getInetRadioFavorites - Reads the favorites. (May take some seconds...).
- getInetRadioPresets - Reads the presets. (May take some seconds...).
- inetRadioFavorite [1..24] - Selects an internet radio favorite (May take some seconds...).
- inetRadioPreset [1..24] - Selects an internet radio preset (May take some seconds...).
- inetRadioFavoriteByName [name] - Selects an internet radio favorite by name. (getInetRadioFavorites must be run previously for the command to become available.) (May take some seconds...).
- inetRadioPresetByName [name] - Selects an internet radio preset by name. (getInetRadioPresets must be run previously for the command to become available.) (May take some seconds...).
- mute - Mutes the device.
- unmute - Unmutes the device.
- next - Selects the next song, preset etc.
- play_pause - Toggles PLAY/PAUSE.
- previous - Selects the previous song, preset etc.
- repeat [single|all|off] - Sets the repeat mode.
- shuffle [on|off] - Sets the shuffle mode.
- standbyButton - Toggles between standby and power on.
- statusRequest - Updates the readings.
- stop - Stops the player.
- volume - Sets the relative volume 0...100%.
- volumeStraight - Sets the absolute volume 0...64.

A typical example is powering the device remotely and tuning the favourite radio station:
Add the following code into the fhem.cfg configuration file:

`define PHAUDIO_player PHILIPS_AUDIO NP3900 192.168.0.15 30 5
attr PHAUDIO_player webCmd volume:mute:inetRadioPreset`

Add the following code into the 99_MyUtils.pm file:

`sub startMyFavouriteRadioStation()
{
fhem "set PHAUDIO_player inetRadioPreset 1";
sleep 1;
fhem "set PHAUDIO_player volume 30";
}`

It's a good idea to insert a 'sleep' instruction between each fhem commands due to internal processing time of the player. Be patient when executing the commands...
Now the function can be called by typing the following line in the FHEM command line or by the notify-definitions:

`{startMyFavouriteRadioStation()}
`

Get

`get <name> <reading>`
Currently, the 'get' command returns reading values only. For a specific list of possible values, see section "Generated Readings".

Attributes

- do_not_notify
- readingFnAttributes
- request-timeout
Optional attribute change the response timeout in seconds for all queries to the receiver.
Possible values: 1...5 seconds. Default value is 4 seconds.
- max-device-presets
Optional attribute defining maximum number of available preset slots in device's memory. Default value 24.
- max-device-favorites
Optional attribute defining maximum number of favorite slots in device's memory. Default value 24.
- disable
Optional attribute to disable the internal cyclic status update of the receiver. Manual status updates via statusRequest command is still possible.
Possible values: 0 → perform cyclic status update, 1 → don't perform cyclic status updates.

Readings

- albumArt - Link to current album art or radio station.
- elapseTime - Elapse time of the played audio.
- inetRadioFavorite[value] - Name of the stored favorite.
- inetRadioPreset[value] - Name of the stored preset.
- mute - Reports the mute status (on|off).
- playing - Reports the current playier status (yes|no).
- power - Reports the current power status (on|absent).
- presence - Reports the current presence (present|absent).
- state - Reports the current state status (on|absent).
- subtitle - Reports the current subtitle of played audio.
- totalInetRadioFavorites - Number of stored favorites.
- totalInetRadioPresets - Number of stored presets.
- title - Reports the current title of played audio.
- totalTime - Reports the total time of the played audio.
- volume - Reports current relative volume (0..100).
- volumeStraight - Reports current absolute volume (0..64).

Implementer's note

Trivial: In order to use that module the network player must be connected to the Ethernet.
There's no possibility to read back the current power on/standby status from the device. This fuctionality is missing in the server application.

### PHTV

Define

`define <name> PHTV <ip-address-or-hostname> [<poll-interval>]`
This module controls Philips TV devices and their Ambilight via network connection.
Defining a PHTV 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 PhilipsTV PHTV 192.168.0.10
# With custom interval of 20 seconds
define PhilipsTV PHTV 192.168.0.10 20`

Note: Some older devices might need to have the API activated first. If you get no response from your device, try to input "5646877223" on the remote while watching TV (which spells jointspace on the digits). A popup might appear stating the API was successfully enabled.

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
- channel channel,0...999,sRef - zap to specific channel or service reference
- channelUp - zap to next channel
- channelDown - zap to previous channel
- volume 0...100 - set the volume level in percentage
- volumeStraight 1...60 - set the volume level in device specific range
- volumeUp - increases the volume level
- volumeDown - decreases the volume level
- mute on,off,toggle - controls volume mute
- input ... - switches between inputs
- statusRequest - requests the current status of the device
- remoteControl UP,DOWN,... - sends remote control commands; see remoteControl help
- ambiHue on,off - activates/disables Ambilight+Hue function
- ambiMode internal,manual,expert - set source register for Ambilight
- ambiPreset - set Ambilight to predefined state
- rgb HEX,LED address - set an RGB value for Ambilight
- hue 0-65534 - set the color hue value Ambilight
- sat 0-255 - set the saturation value for Ambilight
- bri 0-255 - set the brightness value for Ambilight
- play - starts/resumes playback
- pause - starts/resumes playback
- stop - stops current playback
- record - starts recording of current channel

Note: If you would like to restrict access to admin set-commands (-> statusRequest) 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.

Advanced Ambilight Control

If you would like to specificly control color for individual sides or even individual LEDs, you may use special addressing to be used with set command 'rgb':
LED addressing format:
`<Layer><Side><LED number>`
Examples:

`# set LED 0 on left side within layer 1 to color RED
set PhilipsTV rgb L1L0:FF0000
# set LED 0, 2 and 4 on left side within layer 1 to color RED
set PhilipsTV rgb L1L0:FF0000 L1L2:FF0000 L1L4:FF0000
# set complete right side within layer 1 to color GREEN
set PhilipsTV rgb L1R:00FF00
# set complete layer 1 to color BLUE set PhilipsTV rgb L1:0000FF`

Advanced Ambilight+HUE Control

Linking to your HUE devices within attributes ambiHueLeft, ambiHueTop, ambiHueRight and ambiHueBottom uses some defaults to calculate the actual color.
More than one HUE device may be added using blank.
The following settings can be fine tuned for each HUE device:
- LED(s) to be used as color source
  either 1 single LED or a few in a raw like 2-4. Defaults to use the middle LED and it's left and right partners. Counter starts at 1. See readings ambiLED* for how many LED's your TV has.
- saturation in percent of the original value (1-99, default=100)
- brightness in percent of the original value (1-99, default=100)
Use the following addressing format for fine tuning:
`devicename:<LEDs$gt;:<saturation$gt;:<brightness$gt;`
Examples:

`# to push color from top to 2 HUE devices
attr PhilipsTV ambiHueTop HUEDevice0 HUEDevice1
# to use only LED 4 from the top as source
attr PhilipsTV ambiHueTop HUEDevice0:4
# to use a combination of LED's 1+2 as source
attr PhilipsTV ambiHueTop HUEDevice0:1-2
# to use LED's 1+2 and only 90% of their saturation
attr PhilipsTV ambiHueTop HUEDevice0:1-2:90
# to use LED's 1+2 and only 50% of their brightness
attr PhilipsTV ambiHueTop HUEDevice0:1-2::50
# to use LED's 1+2, 90% saturation and 50% brightness
attr PhilipsTV ambiHueTop HUEDevice0:1-2:90:50
# to use default LED settings but only adjust their brightness to 50%
attr PhilipsTV ambiHueTop HUEDevice0:::50`

Get

`get <name> <what>`
Currently, the following commands are defined:

`channel
mute
power
input
volume
rgb
`

Attributes

- ambiHueLeft - HUE devices that should get the color from left Ambilight.
- ambiHueTop - HUE devices that should get the color from top Ambilight.
- ambiHueRight - HUE devices that should get the color from right Ambilight.
- ambiHueBottom - HUE devices that should get the color from bottom Ambilight.
- ambiHueLatency - Controls the update interval for HUE devices in milliseconds; defaults to 200 ms.
- channelsMax - Maximum amount of channels shown in FHEMWEB. Defaults to 80.
- disable - Disable polling (true/false)
- drippyFactor - Adds some delay in seconds after low-performance devices came up to allow more time to become responsive (default=0)
- inputs - Presents the inputs read from device. Inputs can be renamed by adding `,NewName` right after the original name.
- jsversion - JointSpace protocol version; e.g. pre2014 devices use 1, 2014 devices use 5 and 2015 devices use 6. defaults to 1
- sequentialQuery - avoid parallel queries for low-performance devices
- timeout - Set different polling timeout in seconds (default=7)

Generated Readings/Events:

- ambiHue - Ambilight+Hue status
- ambiLEDBottom - Number of LEDs of bottom Ambilight
- ambiLEDLayers - Number of physical LED layers
- ambiLEDLeft - Number of LEDs of left Ambilight
- ambiLEDRight - Number of LEDs of right Ambilight
- ambiLEDTop - Number of LEDs of top Ambilight
- ambiMode - current Ambilight color source
- channel - Shows the service name of current channel; part of FHEM-4-AV-Devices compatibility
- country - Set country
- currentMedia - The preset number of this channel; part of FHEM-4-AV-Devices compatibility
- frequency - Shows current channels frequency
- input - Shows currently used input; part of FHEM-4-AV-Devices compatibility
- language - Set menu language
- model - Device model
- mute - Reports the mute status of the device (can be "on" or "off")
- onid - The ON ID
- power - Reports the power status of the device (can be "on" or "off")
- presence - Reports the presence status of the receiver (can be "absent" or "present"). In case of an absent device, control is basically limited to turn it on again. This will only work if the device supports Wake-On-LAN packages, otherwise command "on" will have no effect.
- receiveMode - Receiving mode (analog or DVB)
- rgb - Current Ambilight color if ambiMode is not set to internal and all LEDs have the same color
- rgb_X - Current Ambilight color of a specific LED if ambiMode is not set to internal
- serialnumber - Device serial number
- servicename - Name for current channel
- sid - The S-ID
- state - Reports current power state and an absence of the device (can be "on", "off" or "absent")
- systemname - Device system name
- tsid - The TS ID
- volume - Reports current volume level of the receiver in percentage values (between 0 and 100 %)
- volumeStraight - Reports current volume level of the receiver in device specific range

### PID20

Define

`define <name> PID20 <sensor[:reading[:regexp]]> <actor:cmd >`
This module provides a PID device, using <sensor> and <actor>

Set-Commands

`set <name> desired <value>`

Set desired value for PID

`set <name> start`

Start PID processing again, using frozen values from former stop.

`set <name> stop`

PID stops processing, freezing all values.

`set <name> restart <value>`

Same as start, but uses value as start value for actor

Get-Commands

`get <name> params`

Get list containing current parameters.

Attributes

- readingFnAttributes
- disable - disable the PID device, possible values: 0,1; default: 0
- pidActorValueDecPlaces - number of demicals, possible values: 0..5; default: 0
- pidActorInterval - number of seconds to wait between to commands sent to actor; default: 180
- pidActorTreshold - threshold to be reached before command will be sent to actor; default: 1
- pidActorErrorAction - required action on error, possible values: freeze,errorPos; default: freeze
- pidActorErrorPos - actor's position to be used in case of error; default: 0
- pidActorKeepAlive - number of seconds to force command to be sent to actor; default: 1800
- pidActorLimitLower - lower limit for actor; default: 0
- pidActorLimitUpper - upper limit for actor; default: 100
- pidCalcInterval - interval (seconds) to calculate new pid values; default: 60
- pidDeltaTreshold - if delta < delta-threshold the pid will enter idle state; default: 0
- pidDesiredName - reading's name for desired value; default: desired
- pidFactor_P - P value for PID; default: 25
- pidFactor_I - I value for PID; default: 0.25
- pidFactor_D - D value for PID; default: 0
- pidMeasuredName - reading's name for measured value; default: measured
- pidSensorTimeout - number of seconds to wait before sensor will be recognized n/a; default: 3600
- pidReverseAction - reverse PID operation mode, possible values: 0,1; default: 0
- pidUpdateInterval - number of seconds to wait before an update will be forced for plotting; default: 300
- pidActorCallBeforeSetting - an optional callback-function,which can manipulate the actorValue; default: not defined

              # Exampe for callback-function
              # 1. argument = name of PID20
              # 2. argument = current actor value
                sub PIDActorSet($$)
                {
                    my ( $name, $actValue ) = @_;
                    if ($actValue>70)
                    {
                      $actValue=100;
                    }
                    return $actValue;
                }

- pidIPortionCallBeforeSetting - an optional callback-function, which can manipulate the value of I-Portion; default: not defined

              # Exampe for callback-function
              # 1. argument = name of PID20
              # 2. argument = current i-portion value
                sub PIDIPortionSet($$)
                {
                    my ( $name, $actValue ) = @_;
                    if ($actValue>70)
                    {
                      $actValue=70;
                    }
                    return $actValue;
                }

Generated Readings/Events:

- actuation - real actuation set to actor
- actuationCalc - internal actuation calculated without limits
- delta - current difference desired - measured
- desired - desired value
- measured - measured value
- p_p - p value of pid calculation
- p_i - i value of pid calculation
- p_d - d value of pid calculation
- state - current device state
Names for desired and measured readings can be changed by corresponding attributes (see above).

Additional information

- Discussion in FHEM forum
- Information in FHEM wiki

### PIFACE

The PIFACE module managed the Raspberry Pi extension board PiFace Digital.
PIFACE controls the input ports 0..7 and output ports 0..7.

- The relays 0 and 1 have corresponding output port 0 and 1.
- The switches 0..3 have corresponding input ports 0..3 and must be read with attr portMode<0..7> = up

The status of the ports can be displayed periodically. The update of the states via interrupt is not supported.
The module can be periodically monitored by a watchdog function.
The ports can be read and controlled individually by the function readingsProxy.
PIFACE is tested with the Raspbian OS.
Preparatory Work
The use of PIFACE module requires some preparatory work. The module needs the Wiring Pi tool.

Raspbian Wheezy
- Install it with
  `git clone git://git.drogon.net/wiringPi
  cd wiringPi
  ./build`
Raspbian Jessie
- Install it with
  `sudo apt-get install wiringpi`
- PiFace Digital need the SPI pins on the Raspberry Pi to be enabled in order to function. Start `sudo raspi-config`, select `Advanced Options` and set the `A5 SPI` option to "Yes".
- The function of the PiFace Digital can be tested at OS command line. For example:
  `gpio -p readall`
  `gpio -p read 200`
  `gpio -p write 201 0` or `gpio -p write 201 1`
- The watchdog function monitors the input port 7 and the output port 7.
  If the watchdog is enabled, this ports can not be used for other tasks. In order to monitor the input port 7, it must be connected to the ground!
  The OS command "shutdown" must be enable for fhem if an OS restart is to be executed in case of malfunction. For example, with `chmod +s /sbin/shutdown` or `sudo chmod +s /sbin/shutdown`.

Raspbian Jessie
- PiFace Digital need the SPI pins on the Raspberry Pi to be enabled in order to function. Start `sudo raspi-config`, select `9 Advanced Options` and set the `A6 SPI` option to "Yes".
- The function of the PiFace Digital can be tested at OS command line. For example:
  `gpio -p readall`
  `gpio -p read 200`
  `gpio -p write 201 0` or `gpio -p write 201 1`
- The watchdog function monitors the input port 7 and the output port 7.
  If the watchdog is enabled, this ports can not be used for other tasks. In order to monitor the input port 7, it must be connected to the ground!
  The OS command "shutdown" must be enable for fhem if an OS restart is to be executed in case of malfunction. For example, with `chmod +s /sbin/shutdown` or `sudo chmod +s /sbin/shutdown`.

Define

`define <name> PIFACE`

Set

`set <name> <port> <value>`

- set single port n to 1 (on) or 0 (off)
  Examples:
  set <name> 3 1 => set port 3 on
  set <name> 5 0 => set port 5 off
- set all ports in one command by bitmask
  Example:
  set <name> all 255 => set all ports on
  set <name> all 0 => set all ports off
  set <name> all 170 => bitmask(170) = 10101010 => set ports 1 3 5 7 on, ports 0 2 4 6 off
  `port 76543210
  bit 10101010`

Get

`get <name> <port>`

- get state of single port
  Example:
  get <name> 3 => get state of port 3
- get state of input ports and update changed readings
  Example:
  get <name> in => get state of all input ports
- get state of out ports and update changed readings
  Example:
  get <name> out => get state of all output ports
- get state of input and out ports and update all readings
  Example:
  get <name> all => get state of all ports

Attributes

- defaultState last|off|0|1, [defaultState] = off is default.
  Restoration of the status of the output port after a Fhem reboot.
- disable 0|1
  If applied set commands will not be executed.
- disabledForIntervals HH:MM-HH:MM HH:MM-HH-MM...
  Space separated list of HH:MM tupels. If the current time is between the two time specifications, set commands will not be executed. Instead of HH:MM you can also specify HH or HH:MM:SS. To specify an interval spawning midnight, you have to specify two intervals, e.g.:
  23:00-24:00 00:00-01:00
- pollInterval off|1,2,...,9,10, [pollInterval] = off is default.
  Define the polling interval of the input ports in seconds.
- portMode<0..7> tri|up, [portMode<0..7>] = tri is default.
  This enables (up) or disables (tri) the internal pull-up resistor on the given input port. You need to enable the pull-up if you want to read any of the on-board switches on the PiFace board.
- readingFnAttributes
- watchdog off|on|silent, [watchdog] = off is default.
  The function of the PiFace extension can be monitored periodically. The watchdog module checks the function of ports in7 and out7. If the watchdog function is to be used, ports in7 and out7 are reserved for this purpose. The port 7 must be connected to ground.
  If [watchdog] = on, the result of which is periodically logged and written to the reading watchdog.
  If [watchdog] = silent, FHEM is restarted after the first error detected. If the error could not be eliminated, then the Raspberry operating system is restarted. If the error is not corrected as well, the monitoring function is disabled and the error is logged.
- watchdogInterval 10..65535, [watchdogInterval] = 60 is default.
  Interval between two monitoring tests in seconds.

Generated Readings/Events:

- <out0..out7>: 0|1
  state of output port 0..7
- <in0..in7>: 0|1
  state of input port 0..7
- watchdog: off|ok|error|restart|start
  state of the watchdog function
- state: active|error

### PIONEERAVR

This module allows to remotely control a Pioneer AV receiver (only the Main zone, other zones are controlled by the module PIONEERAVRZONE) equipped with an Ethernet interface or a RS232 port. It enables Fhem to

- switch ON/OFF the receiver
- adjust the volume
- set the input source
- and configure some other parameters

This module is based on the Pioneer documentation and tested with a Pioneer AV receiver VSX-923 from Pioneer.
Note: this module requires the Device::SerialPort or Win32::SerialPort module if the module is connected via serial Port or USB.
This module tries to

- keep the data connection between Fhem and the Pioneer AV receiver open. If the connection is lost, this module tries to reconnect once
- forwards data to the module PIONEERAVRZONE to control the ZONEs of a Pioneer AV receiver

As long as Fhem is connected to the Pioneer AV receiver no other device (e.g. a smart phone) can connect to the Pioneer AV receiver on the same port. Some Pioneer AV receivers offer more than one port though. From Pioneer recommend port numbers:00023,49152-65535, Invalid port numbers:00000,08102
Define

`define <name> PIONEERAVR telnet <IPAddress:Port>`
or
`define <name> PIONEERAVR serial <SerialDevice>[<@BaudRate>]`
Defines a Pioneer AV receiver device (communication interface and main zone control). The keywords `telnet` or `serial` are fixed. Default port on Pioneer AV receivers is 23 (according to the above mentioned Pioneer documetation) or 8102 (according to posts in the Fhem forum)
Note: PIONEERAVRZONE devices to control zone2, zone3 and/or HD-zone are autocreated on reception of the first message for those zones.
Examples:

`define VSX923 PIONEERAVR telnet 192.168.0.91:23`
`define VSX923 PIONEERAVR serial /dev/ttyS0`
`define VSX923 PIONEERAVR serial /dev/ttyUSB0@9600`

Set

`set <name> <what> [<value>]`
where <what> is one of
- bass <-6 ... 6> - Bass from -6dB to + 6dB (is only available if tone = on and the ListeningMode supports it)
- channel <1 ... 9> - To change the tuner preset. Only available for input = 2 (Tuner)
- channelDown - Changes to the next lower tuner preset. Only available for input = 2 (Tuner)
- channelStraight <A1...G9> -
To change the tuner preset with values as they are shown in the display of the Pioneer AV receiver eg. "A1". Only available for input = 2 (Tuner)
- channelUp - Changes to the next higher tuner preset. Only available for input = 2 (Tuner)
- down - "arrow key down". Available for the same inputs as "play"
- enter - "Enter key". Available for the same inputs as "play"
- eq <on|off> - Turns the equalizer on or off
- fwd - Fast forward. Available for the same inputs as "play"
- hdmiOut <1+2|1|2|off> - Switches the HDMI output 1 and/or 2 of the Pioneer AV Receivers on or off.
- input <not on the Pioneer hardware deactivated input> The list of possible (i.e. not deactivated) inputs is read in during Fhem start and with `get <name> statusRequest`. Renamed inputs are shown with their new (renamed) name
- inputDown - Select the next lower input for the Main Zone
- inputUp - Select the next higher input for the Main Zone
- left - "Arrow key left". Available for the same inputs as "play"
- listeningMode - Sets a ListeningMode e.g. autoSourround, direct, action,...
- mcaccMemory <1...6> - Sets one of the 6 predefined MCACC settings for the Main Zone
- menu - "Menu-key" of the remote control. Available for the same inputs as "play"
- mute <on|off|toggle> - Mute the Main Zone of the Pioneer AV Receiver. "mute = on" means: Zero volume
- networkStandby <on|off> - Turns Network standby on or off. To turn on a Pioneer AV Receiver with this module from standby, Network Standby must be "on". `set <name> networkStandby on` should do this
- next - Available for the same inputs as "play"
- off - Switch the Main Zone to standby
- on - Switch the Main Zone on from standby. This can only work if "Network Standby" is "on" in the Pioneer AV Receiver. Refer to "networkStandby" above.
- pause - Pause replay. Available for the same inputs as "play"
- play - Starts replay for the following inputs:
  - usbDac
  - ipodUsb
  - xmRadio
  - homeMediaGallery
  - sirius
  - adapterPort
  - internetRadio
  - pandora
  - mediaServer
  - favorites
  - mhl
- prev - Changes to the previous title. Available for the same inputs as "play".
- raw <PioneerKommando> - Sends the command `<PioneerCommand>` unchanged to the Pioneer AV receiver. A list of all available commands is available in the Pioneer documentation mentioned above
- remoteControl <attr> - where <attr> is one of:
  - cursorDown
  - cursorRight
  - cursorLeft
  - cursorEnter
  - cursorReturn
  - homeMenu
  - statusDisplay
  - audioParameter
  - hdmiOutputParameter
  - videoParameter
  - homeMenu
  Simulates the keys of the remote control. Warning: The cursorXX keys cannot change the inputs -> set <name> up ... can be used for this
- reopen - Tries to reconnect Fhem to the Pioneer AV Receiver
- repeat - Repeat for the following inputs: AdapterPort, Ipod, Favorites, InternetRadio, MediaServer. Cycles between
  - no repeat
  - repeat current title
  - repeat all titles
- return - "Return key". Available for the same inputs as "play"
- rev - "rev key". Available for the same inputs as "play"
- right - "Arrow key right". Available for the same inputs as "play"
- selectLine01 - selectLine08 - Available for the same inputs as "play". If there is an OSD you can select the lines directly
- shuffle - Random replay. For the same inputs available as "repeat". Toggles between random on and off
- signalSelect <auto|analog|digital|hdmi|cycle> - Signal select function
- speakers <off|A|B|A+B> - Turns speaker A and or B on or off.
- standingWave <on|off> - Turns Standing Wave on or off for the Main Zone
- statusRequest - Asks the Pioneer AV Receiver for information to update the modules readings
- stop - Stops replay. Available for the same inputs as "play"
- toggle - Toggle the Main Zone to/from Standby
- tone <on|bypass> - Turns tone on or in bypass
- treble <-6 ... 6> - Treble from -6dB to + 6dB (works only if tone = on and the ListeningMode permits it)
- up - "Arrow key up". Available for the same inputs as "play"
- volume <0 ... 100> - Volume of the Main Zone in % of the maximum volume
- volumeDown - Reduce the volume of the Main Zone by 0.5dB
- volumeUp - Increase the volume of the Main Zone by 0.5dB
- volumeStraight<-80.5 ... 12> - Set the volume of the Main Zone with values from -80 ... 12 (As it is displayed on the Pioneer AV receiver
- set extensions are supported (except `<blink>` )
Example:

`set VSX923 on`

`set <name> reopen`
Closes and reopens the device. Could be handy if the connection between Fhem and the Pioneer AV receiver is lost and cannot be reestablished automatically.

Get does not return any value but asks the Pioneer AVR for the current status (e.g. of the volume). As soon as the Pioneer AVR replies (the time, till the Pioneer AVR replies is unpredictable), the readings or internals of this pioneerAVR modul are updated.

- loadInputNames - reads the names of the inputs from the Pioneer AV receiver and checks if those inputs are enabled
- audioInfo - get the current audio parameters from the Pioneer AV receiver (e.g. audioInputSignal, audioInputFormatXX, audioOutputFrequency)
- display - updates the reading 'display' and 'displayPrevious' with what is shown on the display of the Pioneer AV receiver
- bass - updates the reading 'bass'
- channel -
- currentListIpod - updates the readings currentAlbum, currentArtist, etc.
- currentListNetwork -
- display -
- input -
- listeningMode -
- listeningModePlaying -
- macAddress -
- avrModel - get the model of the Pioneer AV receiver, eg. VSX923
- mute -
- networkPorts - get the open tcp/ip ports of the Pioneer AV Receiver
- networkSettings - get the IP network settings (ip, netmask, gateway,dhcp, dns1, dns2, proxy) of the Pioneer AV Receiver. The values are stored as INTERNALS not as READINGS
- networkStandby - get the current setting of networkStandby -> the value of networkStandby (on|off) is stored as an INTERNAL not as a READING
- power - get the Power state of the Pioneer AV receiver
- signalSelect -
- softwareVersion - get the software version of the software currently running in the Pioneer AV receiver. The value is stored as INTERNAL
- speakers -
- speakerSystem -
- tone -
- tunerFrequency - get the current frequency the tuner is set to
- tunerChannelNames -
- treble -
- volume -

Attributes

- checkConnection <enable|disable> - Enables/disables the check if the data connection to the Pioneer AV receiver is open.(Default: enable)
- 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,...
- verbose - 0: log es less as possible, 5: log as much as possible
- volumeLimit <0 ... 100> - limits the volume to the given value
- volumeLimitStraight <-80 ... 12> - limits the volume to the given value

Generated Readings/Events:

- audioAutoPhaseControlMS - currently configured Auto Phase Control in ms
- audioAutoPhaseControlRevPhase - acurrently configured Auto Phase Control reverse Phase -> 1 means: reverse phase
- audioInputFormat<XXX> - Shows if the channel XXX is available in the audio input signal (1 means: is available)
- audioInputFrequency - Frequency of the input signal
- audioInputSignal - Type of the input signal (z.B. ANALOG, PCM, DTS,...)
- audioOutputFormat<XXX> - Shows if the channel XXX is available in the audio output sgnal (1 means: is available)
- audioOutputFrequency - Frequency of the audio output signal
- bass - currently set bass
- channel - Tuner Preset (1...9)
- channelStraight - Tuner Preset as diplayed in the display of the Pioneer AV Receiver, e.g. A2
- display - Currently dispayed text in the display of the Pioneer AV Receiver
- displayPrevious - Previous displayed text
- eq - Equalizer status of the Pioneer AV Receiver (on|off)
- hdmiOut - Shows the currently selected HDMI-output(s)?
- input - shows the currently selected input
- inputsList - ":" separated list of all activated inputs
- listeningMode - Currently set Listening Mode
- listeningModePlaying - Currently used Listening Mode
- mcaccMemory - MCACC Setting
- mute - Mute (on|off)
- power - Main Zone on or standby?
- pqlsWorking - currently set PQLS
- presence - Is the Pioneer AV Receiver reachable via ethernet?
- screenHirarchy - Hirarchy of the currently shown On Screen Displays (OSD)
- screenLine01...08 - Content of the lines 01...08 of the OSD
- screenLineHasFocus - Which line of the OSD has the focus?
- screenLineNumberFirst - Long lists are shown in the OSD in smaller pages with 8 lines. This shows which elemnt of the lang list is the currently shown first line.
- screenLineNumberLast - Long lists are shown in the OSD in smaller pages with 8 lines. This shows which elemnt of the lang list is the currently shown last line.
- screenLineNumberTotal - How many lines has the full list
- screenLineNumbers - How many lines has the OSD
- screenLineType01...08 - Which type has line 01...08? E.g. "directory", "Now playing", "current Artist",...
- screenName - Name of the OSD
- screenReturnKey - Is the "Return-Key" in this ODS available?
- screenTopMenuKey - Is the "Menu-Key" in this ODS available?
- screenType - Type of the OSD, e.g. "message", "List", "playing(play)",...
- speakerSystem - Shows how the rear surround speaker connectors and the B-speaker connectors are used
- speakers - Which speaker output connectors are active?
- standingWave - Standing wave
- state - Is set while connecting from fhem to the Pioneer AV Receiver (disconnected|innitialized|off|on|opened)
- tone - Is the tone control turned on?
- treble - Current value of treble
- tunerFrequency - Tuner frequency
- volume - Current value of volume (0%-100%)
- volumeStraight - Current value of volume os displayed in the display of the Pioneer AV Receiver

### PIONEERAVRZONE

Define

`define <name> PIONEERAVRZONE <zone>`
Defines a Zone (zone2, zone3 or hdZone) of a PioneerAVR device.
Note: devices to control zone2, zone3 and/or HD-zone are autocreated on reception of the first message for those zones.
Normally, the PIONEERAVRZONE device is attached to the latest previously defined PIONEERAVR device for I/O. Use the `IODev` attribute of the PIONEERAVRZONE device to attach to any PIONEERAVR device, e.g. `attr myPioneerAvrZone2 IODev myPioneerAvr`.
Examples:

`define myPioneerAvrZone2 PIONEERAVRZONE zone2`
`attr myPioneerAvrZone2 IODev myPIONEERAVR`

Set

`set <name> <what> [<value>]`
where <what> is one of
- reopen
- off
  put zone into standby
- on
  turn zone on from standby
- toggle
  toggles zone power
- volume <0 ... 100>
  zone volume in % of the maximum volume
- volumeUp
  increases the zone volume by 0.5dB
- volumeDown
  decreases the zone volume by 0.5dB
- volumeStraight<-80.5 ... 12>
  same values for zone volume as shown on the display of the Pioneer AV receiver
- mute <on|off|toggle>
- input <not on the Pioneer hardware deactivated input>
  the list of possible (i.e. not deactivated) inputs is read in during Fhem start and with `get <name> statusRequest`
- inputUp
  change zone input to next input
- inputDown
  change zone input to previous input
- set extensions are supported (except `<name>`)
Example:

`set VSX923Zone2 on`

Get

- `get <name> input`
  Update the reading for the zone input

Attributes

- IOdev Name of the device which communicates with the phisical Pioneer AV receiver via ethernet or rs232
- verbose

### POKEYS

The POKEYS module is used to control the LAN POKEYS device (POKEYS56e) which supports up to 56 digital input, analog inputs, counter inputs and digital outputs. Each port/pin has to be configured before it can be used.
Define

`define <name> POKEYS <ip-address> <pin> <io-state> [<time in ms>]`
`<ip-address>` the IP address where the POKEYS device can be accessed
`<pin>` the pin number which should be configured
`<io-state>` the new io state of the pin `Obsolete(=undef) DigIn DigOut AdcIn DigInCtRise DigInCtFall ExtDigOut GetBasic`
`<time in ms>` optional else 1000ms: cyclic update time for Input pin
Example:

`define PoInfo POKEYS 192.168.178.34 0 GetBasic`
# creates a virtual pin for getting infos about the device with the `get` command
`define Pin44in POKEYS 192.168.178.34 44 DigIn 200`
# creates a digitial input port on pin 44
`define Pin25out POKEYS 192.168.178.34 25 DigOut`
# creates a digial output port on pin 25

Set

`set <name> <state> [<time in ms>]`
`<state>` can be `OFF ON OFF_PULSE ON_PULSE`
`<time in ms>` optional else 1000ms hold time for the `ON_PULSE OFF_PULSE` state
Example:

`set Pin25out ON`
# sets Pin25out to ON (0V)

Get

`get <name> <type>`
only supported for pins of type `GetBasic`
`<type>` can be `Version DevName Serial User CPUload`
Example:

`get PoInfo Version`
# gets the version of the POKEYS device

Attributes

todo

### PRESENCE

The PRESENCE module provides several possibilities to check the presence of mobile phones or similar mobile devices such as tablets.
This module provides several operational modes to serve your needs. These are:

- lan-ping - A presence check of a device via network ping in your LAN/WLAN.
- fritzbox - A presence check by requesting the device state from the FritzBox internals (only available when running FHEM on a FritzBox!).
- local-bluetooth - A presence check by searching directly for a given bluetooth device nearby.
- function - A presence check by using your own perl function which returns a presence state.
- shellscript - A presence check by using an self-written script or binary which returns a presence state.
- event - A presence check by listening to FHEM events of other definitions.
- lan-bluetooth - A presence check of a bluetooth device via LAN network by connecting to a presenced or collectord instance.

Each mode can be optionally configured with a specific check interval and a present check interval.

- check-interval - The interval in seconds between each presence check. Default value: 30 seconds
- present-check-interval - The interval in seconds between each presence check in case the device is present. Otherwise the normal check-interval will be used.

Define

Mode: lan-ping
`define <name> PRESENCE lan-ping <ip-address> [ <check-interval> [ <present-check-interval> ] ]`
Checks for a network device via PING requests and reports its presence state.
Example
`define iPhone PRESENCE lan-ping 192.168.179.21`
Mode: fritzbox
`define <name> PRESENCE fritzbox <device-name/mac-address> [ <check-interval> [ <present-check-interval> ] ]`
Checks for a network device by requesting the internal state on a FritzBox via ctlmgr_ctl. The device-name must be the same as shown in the network overview of the FritzBox or can be substituted by the MAC address with the format XX:XX:XX:XX:XX:XX
This check is only applicable when FHEM is running on a FritzBox! The detection of absence can take about 10-15 minutes!
Example
`define iPhone PRESENCE fritzbox iPhone-6`
`define iPhone PRESENCE fritzbox 00:06:08:05:0D:00`
Mode: local-bluetooth
`define <name> PRESENCE local-bluetooth <bluetooth-address> [ <check-interval> [ <present-check-interval> ] ]`
Checks for a bluetooth device and reports its presence state. For this mode the shell command "hcitool" is required (provided with a bluez installation under Debian via APT), as well as a functional bluetooth device directly attached to your machine.
Example
`define iPhone PRESENCE local-bluetooth 0a:8d:4f:51:3c:8f`
Mode: function
`define <name> PRESENCE function {...} [ <check-interval> [ <present-check-interval> ] ]`
Checks for a presence state via perl-code. You can use a self-written perl function to obtain the presence state of a specific device (e.g. via SNMP check).
The function must return 0 (absent) or 1 (present). An example can be found in the FHEM-Wiki.
Example
`define iPhone PRESENCE function {snmpCheck("10.0.1.1","0x44d77429f35c")}`
Mode: shellscript
`define <name> PRESENCE shellscript "<path> [<arg1>] [<argN>]..." [ <check-interval> [ <present-check-interval> ] ]`
Checks for a presence state via shell script. You can use a self-written script or binary in any language to obtain the presence state of a specific device (e.g. via SNMP check).
The shell must return 0 (absent) or 1 (present) on console (STDOUT). Any other values will be treated as an error
Example
`define iPhone PRESENCE shellscript "/opt/check_device.sh iPhone"`
Mode: event
`define <name> PRESENCE evemt <absent-regexp> <present-regexp>`
Listens for events of other FHEM definitions to determine a presence state. You must provide two event regexp's in the same style as for the notify module.
If an event matches one of the provides regexps, the presence state will be changed.
Example
`define Presence_John PRESENCE event Door_Switch:off Door_Switch:on`
Mode: lan-bluetooth
Checks for a bluetooth device with the help of presenced or collectord. They can be installed where-ever you like, just must be accessible via network. The given device will be checked for presence status.
`define <name> PRESENCE lan-bluetooth <bluetooth-address> <ip-address>[:port] [ <check-interval> ]`
The default port is 5111 (presenced). Alternatly you can use port 5222 (collectord)
Example
`define iPhone PRESENCE lan-bluetooth 0a:4f:36:d8:f9:89 127.0.0.1:5222`
presenced

The presence is a perl network daemon, which provides presence checks of multiple bluetooth devices over network. It listens on TCP port 5111 for incoming connections from a FHEM PRESENCE instance or a running collectord.

    Usage:
      presenced [-d] [-p <port>] [-P <filename>]
      presenced [-h | --help]

    Options:
      -p, --port
         TCP Port which should be used (Default: 5111)
      -P, --pid-file
         PID file for storing the local process id (Default: /var/run/presenced.pid)
      -d, --daemon
         detach from terminal and run as background daemon
      -v, --verbose
         Print detailed log output
      -h, --help
         Print detailed help screen

It uses the hcitool command (provided by a bluez installation) to make a paging request to the given bluetooth address (like 01:B4:5E:AD:F6:D3). The devices must not be visible, but still activated to receive bluetooth requests.
If a device is present, this is send to FHEM, as well as the device name as reading.
The presenced is available as:

- direct perl script file: presenced
- .deb package for Debian (noarch): presenced-1.4.deb
- .deb package for Raspberry Pi (raspbian): presenced-rpi-1.4.deb

lepresenced

lepresenced is a Perl network daemon that provides presence checks of multiple bluetooth devices over network. In contrast to presenced, lepresenced covers Bluetooth 4.0 (low energy) devices, i. e. Gigaset G-Tags, FitBit Charges. lepresenced listens on TCP port 5333 for connections of a PRESENCE definition or collectord.

    Usage:
        lepresenced --bluetoothdevice <bluetooth device> --listenaddress <listen address> --listenport <listen port> --loglevel <log level> --daemon
        lepresenced -b <bluetooth device> -a <listen address> -p <listen port> -l <log level> -d

    valid log levels:
        LOG_CRIT, LOG_ERR, LOG_WARNING, LOG_NOTICE, LOG_INFO, LOG_DEBUG. Default: LOG_INFO

    Examples:
    	lepresenced --bluetoothdevice hci0 --listenaddress 127.0.0.1 --listenport 5333 --daemon
    	lepresenced --loglevel LOG_DEBUG --daemon

To detect the presence of a device, it uses the command hcitool lescan (package: bluez) to continuously listen to beacons of Bluetooth LE devices.
If a device is present, this is send to FHEM, as well as the device name as reading.
The presenced is available as:

- Perl script: lepresenced
- .deb package (noarch): contrib/PRESENCE/deb/

collectord

The collectord is a perl network daemon, which handles connections to several presenced installations to search for multiple bluetooth devices over network.
It listens on TCP port 5222 for incoming connections from a FHEM presence instance.

    Usage:
      collectord -c <configfile> [-d] [-p <port>] [-P <pidfile>]
      collectord [-h | --help]

    Options:
      -c, --configfile <configfile>
         The config file which contains the room and timeout definitions
      -p, --port
         TCP Port which should be used (Default: 5222)
      -P, --pid-file
         PID file for storing the local process id (Default: /var/run/collectord.pid)
      -d, --daemon
         detach from terminal and run as background daemon
      -v, --verbose
         Print detailed log output
      -l, --logfile <logfile>
         log to the given logfile
      -h, --help
         Print detailed help screen

Before the collectord can be used, it needs a config file, where all different rooms, which have a presenced detector, will be listed. This config file looks like:

        # room definition
        # ===============
        #
        [room-name]              # name of the room
        address=192.168.0.10     # ip-address or hostname
        port=5111                # tcp port which should be used (5111 is default)
        presence_timeout=120     # timeout in seconds for each check when devices are present
        absence_timeout=20       # timeout in seconds for each check when devices are absent

        [living room]
        address=192.168.0.11
        port=5111
        presence_timeout=180
        absence_timeout=20

If a device is present in any of the configured rooms, this is send to FHEM, as well as the device name as reading and the room which has detected the device.
The collectord is available as:

- direct perl script file: collectord
- .deb package for Debian (noarch): collectord-1.7.deb

Set

- statusRequest - Schedules an immediatly check.
- power - Executes the given power command which is set as attribute to power (on or off) the device (only when attribute "powerCmd" is set)

Get

N/A

Attributes

- do_not_notify
- readingFnAttributes
- disable
If this attribute is activated, an active check will be disabled.
Possible values: 0 => not disabled , 1 => disabled
Default Value is 0 (not disabled)
- absenceThreshold
(Not in Mode "event" applicable)
The number of checks that have to result in "absent" before the state of the PRESENCE definition is changed to "absent". This can be used to verify the absence of a device with multiple check runs before the state is finally changed to "absent". If this attribute is set to a value >1, the reading state and presence will be set to "maybe absent" during the absence verification.
Default Value is 1 (no absence verification)
- presenceThreshold
(Not in Mode "event" applicable)
The number of checks that have to result in "present" before the state of the PRESENCE definition is changed to "present". This can be used to verify the permanent presence of a device with multiple check runs before the state is finally changed to "present". If this attribute is set to a value >1, the reading state and presence will be set to "maybe present" during the presence verification.
Default Value is 1 (no presence verification)
- absenceTimeout
(Only in Mode "event" applicable)
The timeout after receiving an "absent" event, before the state of the PRESENCE definition is switched to "absent". This can be used to verify the permanent absence by waiting a specific time frame to not receive an "present" event. If this timeout is reached with no "present" event received in the meantime, the presence state will finally be set to "absent". The timeout is given in HH:MM:SS format, where hours and minutes are optional. If this attribute is set to a valid value, the reading state and presence will be set to "maybe absent" during the absence verification.
Default Value is 0 (no absence verification)
- presenceTimeout
(Only in Mode "event" applicable)
The timeout after receiving an "present" event, before the state of the PRESENCE definition is switched to "present". This can be used to verify the permanent presence by waiting a specific time frame to not receive an "absent" event. If this timeout is reached with no "absent" event received in the meantime, the presence state will finally be set to "present". The timeout is given in HH:MM:SS format, where hours and minutes are optional. If this attribute is set to a valid value, the reading state and presence will be set to "maybe present" during the presence verification.
Default Value is 0 (no presence verification)
- ping_count
(Only in Mode "ping" applicable)
Changes the count of the used ping packets to recognize a present state. Depending on your network performance sometimes a packet can be lost or blocked.
Default Value is 4 (packets)
- bluetooth_hci_device
(Only in Mode "local-bluetooth" applicable)
Set a specific bluetooth HCI device to use for scanning. If you have multiple bluetooth modules connected, you can select a specific one to use for scanning (e.g. hci0, hci1, ...).
- fritzbox_speed
(Only in Mode "fritzbox" applicable)
When this attribute is enabled, the network speed is checked in addition to the device state.
This only makes sense for wireless devices connected directly to the FritzBox.
Possible values: 0 => do not check speed, 1 => check speed when device is active
Default value is 0 (no speed check)
- powerCmd
Define a FHEM command, which powers on or off the device.
When executing the powerCmd (set command: power) following placeholders will be replaced by there corresponding values:

- `$NAME` - name of the PRESENCE definition
- `$ADDRESS` - the address of the PRESENCE definition as given in the define statement
- `$ARGUMENT` - the argument given to the power set command (e.g. "on" or "off)

Example FHEM commands:

- `set PowerSwitch_1 on`
- `set PowerSwitch_1 $ARGUMENT`
- `"/opt/power_on.sh $ADDRESS"`
- `{powerOn("$ADDRESS", "username", "password")}`

Generated Events:

General Events:

- state: (absent|maybe absent|present|disabled|error|timeout) - The state of the device, check errors or "disabled" when the disable attribute is enabled
- presence: (absent|maybe absent|present) - The state of the device. The value "maybe absent" only occurs if absenceThreshold is activated.
- powerCmd: (executed|failed) - power command was executed or has failed

Bluetooth specific events:

- device_name: $name - The name of the Bluetooth device in case it's present

presenced/collectord specific events:

- command_accepted: $command_accepted (yes|no) - Was the last command acknowleged and accepted by the presenced or collectord?
- room: $room - If the module is connected with a collector daemon this event shows the room, where the device is located (as defined in the collectord config file)

### PROPLANTA

The module extracts weather data from www.proplanta.de.
The website provides a forecast for 12 days, for the first 7 days in a 3-hours-interval.
This modul causes a high CPU load. It is recommended to reduce the number of captured forecast days.
It uses the perl moduls HTTP::Request, LWP::UserAgent and HTML::Parse.
Define

`define <name> PROPLANTA [City] [CountryCode]`
Example:
`define wetter PROPLANTA Bern ch`
`define wetter PROPLANTA Wittingen+(Niedersachsen)`
- `[City]`
  Optional. The city must be selectable on www.proplanta.de.
  Please pay attention to the Capital letters in the city names. Spaces within the name are replaced by a + (plus).
- `[CountryCode]`
  Optional. Possible values: de (default), at, ch, fr, it
The function `PROPLANTA_Html` creates a HTML code for a 3 day weather forecast.
Example:
`define HTMLForecast weblink htmlCode { PROPLANTA_Html("ProPlanta_Wetter") }`

Set

- `set <name> update`
  The weather data are immediately polled from the website.

Attributes

- `forecastDays <4-14>`
  Number of days for which the forecast data shall be fetched. Default is 14 days (incl. today).
- `INTERVAL <seconds>`
  Poll interval for weather data in seconds (default 3600 = 1 hour)
- `URL <internet address>`
  URL to extract information from. Overwrites the values in the 'define' term.
- readingFnAttributes

Forecast readings

- fc 0|1|2|3|...|13_... - forecast values for today|tommorrow|in 2|3|...|13 days
- fc 0_...00|03|06|09|12|15|18|21 - forecast values for today at 00|03|06|09|12|15|18|21 o'clock
- fc 0_chOfRain Day|Night - chance of rain today by day|night in %
- fc 0_chOfRain 15 - chance of rain today at 15:00 in %
- fc 0_cloud 15 - cloud coverage today at 15:00 in %
- fc 0_dew - dew formation today (0=none, 1=small, 2=medium, 3=strong)
- fc 0_evapor - evaporation today (0=none, 1=small, 2=medium, 3=strong)
- fc 0_frost - ground frost today (0=no, 1=yes)
- fc 0_moon Rise|Set - moon rise|set today
- fc 0_rad - global radiation today
- fc 0_rain 15 - amount of rainfall today at 15:00 o'clock in mm
- fc 0_sun - relative sun shine duration today in % (between sun rise and set)
- fc 0_temp Min|Max - minimal|maximal temperature today in °C
- fc 0_temp 15 - temperatur today at 15:00 o'clock in °C
- fc 0_uv - UV-Index today
- fc 0_weather Morning|Day|Evening|Night - weather situation today morning|during day|in the evening|during night
- fc 0_weather Day Icon - icon of weather situation today by day
- etc.

### PWM

The PMW module implements temperature regulation for heating systems only capeable of switching on/off. PWM is based on Pulse Width Modulation which means valve position 70% is implemented in switching the device on for 70% and off for 30% in a given timeframe. PWM defines a calculation unit and depents on objects based on PWMR which define the rooms to be heated.

Define

`define <name> PWM [<interval>] [<cycletime>] [<minonofftime>] [<maxPulse>] [<maxSwitchOnPerCycle>,<maxSwitchOffPerCycle>] [<roomStayOn>,<roomStayOff>,<stayOnThreshold>] [<overallHeatingSwitch>[,<pulseThreshold>[,<followUpTime>[,<h_regexp_on>[,<delayTimeOn>]]]]]
`
eg. define fb PWM 60 900 120 1 99,99 0,0,0 pumpactor
Define a calculation object with the following parameters:

- interval
  Calculate the pulses every interval seconds. Default is 60 seconds.
- cycletime
  Timeframe to which the pulses refere to. Default is 900 seconds (=15 Minutes). "valve position" of 100% calculates to "on" for this period.
- minonofftime
  Default is 120 seconds. Floor heating systems are driven by thermomechanic elements which react very slow. on/off status changes for lower periods are ignored.
- maxPulse
  Default is 1, which means that a device can be switched on for the full cylcetime period.
  For energy saving reasons it may be wanted to prevent situations were all rooms are switched on (high energy usage) and afterwards off.
  In this case maxPulse is set to 0.85 (=12:45 minutes) which forces a room with a pulse of 1 (=100%) to be switched off after 12:45 minutes to give another room the chance to be switched on.
- maxSwitchOnPerCycle,maxSwitchoffPerCycle
  Defaults are 99 for both values. This means that 99 PWMR object can be switched on or off at the same time.
  To prevent energy usage peaks followend by "no energy consumption" situations set both values to "1".
  This means after the room the the least energy required is switched off the next will be switched off.
  Rooms are switched on or off one after the other (in <interval> cycles) and not all at one time.
  Waiting times are honored by a addon to the pulse.
- roomStayOn,roomStayOff,stayOnThreshold
  Defauts:
  roomStayOn = 0 ... all rooms can be switched off at the same time.
  roomStayOff = 0 ... all rooms can be switched on at the same time.
  stayOnThreshold = 0 ... no impact.
  For energy saving reasons the following may be set: "4,1,0.25". This means:
  The room with the least pulse will be kept off (roomsStayOff=1)
  If the average pulse for the (roomsStayOn=4) rooms with the most heating required is greater than (stayOnThreshold=0.25) then maxRoomStayOn will be kept in state "on", even if the time for the current pulse is reached. If the threshold is not reached (not so much heating required) then all rooms can be switched off at the same time.
- <overallHeatingSwitch>[,<pulseThreshold>[,<followUpTime>[,<regexp_on>[,<delayTimeOn>]]]]
  Universal switch to controll eg. pumps or the heater itself. It will be set to "off" if no heating is required and otherwise "on".
  pulseThreshold defines a threshold which is applied to reading pulseMax, pulseSum, pulseAvg, pulseAvg2 or pulseAvg3 of the PWM object to decide if heating is required. If (calculated pulse > threshold) then actor is set to "on", otherwise "off".
  If pulseThreshold is set to 0 (or is not defined) then the decision is based on roomsOn. If (roomsOn > 0) then actor is set to "on", otherwise "off".
  followUpTime defines a number of seconds which is used to delay the status change from "on" to "off". This can be used to prevent a toggling switch.
  regexp_on defines a regular expression to be applied to the state of the actor. Default is "on". If state matches the regular expression it is handled as "on", otherwise "off".
  delayTimeOn defines a number of seconds which is used to delay the status change from "off" to "on". This can be used to give the valves time to open before switching..
  The pulse used for comparision is defined by attribute overallHeatingSwitchRef. Default is maxPulse.

Example:
`define fh PWM`
which is equal to
`define fh PWM 60 900 120 1 99,99 0,0,0`
Energy saving definition might be
`define fh PWM 60 900 120 0.85 1,1 4,1,0.25`

Set

- cycletime
  Temporary change of parameter cycletime.
- interval
  Temporary change of parameter interval.
- recalc
  Cause recalculation that normally appeary every interval seconds.

Get

- status
  Retrieve content of variable STATE.
- timers
  Retrieve values from the readings "timer?_??" from the attached rooms..
  The readings define start and end times for different room temperatures.
  This funktion will retrieve the first start and the last end time. STATE.

Attributes

- valveProtectIdlePeriod
  Protect Valve by switching on actor for 300 seconds.
  After valveProtectIdlePeriod number of days without switching the valve the actor is set to "on" for 300 seconds. overallHeatingSwitch is not affected.
- overallHeatingSwitchRef
  Defines which reading is used for threshold comparision for OverallHeatingSwitch calculation. Possible values are:
  pulseMax, pulseSum, pulseAvg, pulseAvg2, pulseAvg3, avgPulseRoomsOn
  pulseAvg is an average pulse of all rooms which should be switched to "on".
  pulseAvg2 and pulseAvg3 refer to the 2 or 3 romms with highest pulses.

### PWMR

The PMWR module defines rooms to be used for calculation within module PWM.
PWM is based on Pulse Width Modulation which means valve position 70% is implemented in switching the device on for 70% and off for 30% in a given timeframe.
PWM defines a calculation unit and depents on objects based on PWMR which define the rooms to be heated.
PWMR objects calculate a desired temperature for a room based on several rules, define windows, a temperature sensor and an actor to be used to switch on/off heating.

Define

`define <name> PWMR <IODev> <factor[,offset]> <tsensor[:reading:[t_regexp]]> <actor>[:<a_regexp_on>] [<window|dummy>[,<window>[:<w_regexp>]] [ <usePID=0> | <usePID=1>:<PFactor>:<IFactor>[,<ILookBackCnt>]:<DFactor>[,<DLookBackCnt>] | <usePID=2>:<PFactor>:<IFactor>:<DFactor>[,<DLookBackCnt>] ]
`
Define a calculation object with the following parameters:

- IODev
  Reference to an object of TYPE PWM. This object will switch on/off heating.
- factor[,offset]
  Pulse for PWM will be calculated as ((delta-temp * factor) ** 2) + offset.
  offset defaults to 0.11
  factor can be used to weight rooms.
- tsensor[:reading[:t_regexp]]
  tsensor defines the temperature sensor for the actual room temperature.
  reading defines the reading of the temperature sensor. Default is "temperature"
  t_regexp defines a regular expression to be applied to the reading. Default is '(\d[\d\.]+)'.
- actor[:<a_regexp_on>]
  The actor will be set to "on" of "off" to turn on/off heating.
  a_regexp_on defines a regular expression to be applied to the state of the actor. Default is 'on". If state matches the regular expression it is handled as "on", otherwise "off"
- <window|dummy>[,<window>[:<w_regexp>]
  window defines several window devices that can prevent heating to be turned on.
  If STATE matches the regular expression then the desired-temp will be decreased to frost-protect temperature.
  'dummy' can be used as a neutral value for window and will be ignored when processing the configuration.
  w_regexp defines a regular expression to be applied to the reading. Default is '.*Open.*'.
- `<usePID=0>`
  usePID 0: calculate Pulse based on parameters factor and offset.
  Internals c_factor and c_foffset will reflect the values used for calculatio. Defaults are 1 and 0.11 (if not specified)
  Readings PWMOnTime and PWMPulse will reflect the actual calculated Pulse.
- `<usePID=1>:<PFactor>:<IFactor>[,<ILookBackCnt>]:<DFactor>[,<DLookBackCnt>]`
  PFactor: Konstant for P. Default is 0.8.
  IFactor: Konstant for I. Default is 0.3
  DFactor: Konstant for D. Default is 0.5
  ILookBackCnt: Buffer size to store previous temperatures. For I calculation all values will be used. Default is 5.
  DLookBackCnt: Buffer size to store previous temperatures. For D calculation actual and oldest temperature will be used. Default is 10.
  Internals c_PID_PFactor, c_PID_IFactor, c_PID_ILookBackCnt, c_PID_DFactor, c_PID_DLookBackCnt and c_PID_useit will reflect the above configuration values.
  Readings PID_DVal, PID_IVal, PID_PVal, PID_PWMOnTime and PID_PWMPulse will reflect the actual calculated PID values and Pulse.
- `<usePID=2>:<PFactor>:<IFactor>:<DFactor>[,<DLookBackCnt>]`
  PFactor: Konstant for P. Default is 0.8.
  IFactor: Konstant for I. Default is 0.01
  DFactor: Konstant for D. Default is 0
  DLookBackCnt: Buffer size to store previous temperatures. For D calculation actual and oldest temperature will be used. Default is 10.
  Internals c_PID_PFactor, c_PID_IFactor, c_PID_DFactor, c_PID_DLookBackCnt and c_PID_useit will reflect the above configuration values.
  Readings PID_DVal, PID_IVal, PID_PVal, PID_PWMOnTime and PID_PWMPulse will reflect the actual calculated PID values and Pulse.

Example:
`define roomKitchen PWMR fh 1,0.11 tempKitchen relaisKitchen`
`define roomKitchen PWMR fh 1,0.11 tempKitchen relaisKitchen windowKitchen1,windowKitchen2`
`define roomKitchen PWMR fh 1,0.11 tempKitchen relaisKitchen windowKitchen1,windowKitchen2:.*Open.*`
`define roomKitchen PWMR fh 1,0.11 tempKitchen relaisKitchen windowKitchen1,windowKitchen2`
`define roomKitchen PWMR fh 1,0.11 tempKitchen relaisKitchen dummy 0`
`define roomKitchen PWMR fh 0 tempKitchen relaisKitchen dummy 1:0.8:0.3:0.5`
`define roomKitchen PWMR fh 0 tempKitchen relaisKitchen dummy 1:0.8:0.3,5:0.5,10`
`define roomKitchen PWMR fh 0 tempKitchen relaisKitchen dummy 2:0.8:0.01:00`
`define roomKitchen PWMR fh 0 tempKitchen relaisKitchen dummy 2:0.8:0.01:0.1,10`

Set

- factor
  Temporary change of parameter factor.
- actor
  Set the actor state for this room to on or off. This is only a temporary change that will be overwritten by PWM object.
- desired-temp
  If desired-temp is automatically calculated (attribute autoCalcTemp not set or 1) then the desired temperature is set for a defined time.
  Default for this period is 60 minutes, but it can be changed by attribute autoCalcTemp.
  If desired-temp is not automatically calculated (attribute autoCalcTemp is 0) then this will set the actual target temperature.
- manualTempDuration
  Define the period how long desired-temp manually set will be valid. Default is 60 Minutes.
- interval
  Temporary change INTERVAL which defines how often desired-temp is calculated in autoCalcMode. Default is 300 seconds (5:00 Minutes).
- frostProtect
  Sets attribute frostProtect to 1 (on) or 0 (off).

Get

- previousTemps
  Get conent of buffers defined by ILookBackCnt and DLookBackCnt.

Attributes

- frostProtect
  Switch on (1) of off (0) frostProtectMode. desired-temp will be set to tempFrostProtect in autoCalcMode.
- autoCalcTemp
  Switch on (1) of off (0) autoCalcMode. desired-temp will be set based on the below temperatures and rules in autoCalcMode.
  Default is on.
- tempDay
  Define day temperature. This will be referenced as "D" in the rules.
- tempNight
  Define night temperature. This will be referenced as "N" in the rules.
- tempCosy
  Define cosy temperature. This will be referenced as "C" in the rules.
- tempEnergy
  Define energy saving temperature. This will be referenced as "E" in the rules.
- tempFrostProtect
  Define temperature for frostProtectMode. See also frostProtect.
- tempRule1 ... tempRule5
  Rule to calculate the desired-temp in autoCalcMode.
  Format is: <weekday>[-<weekday] <time>,<temperatureSelector>
  weekday is one of Mo,Di,Mi,Do,Fr,Sa,So
  time is in format hh:mm, e.g. 7:00 or 07:00
  temperatureSelector is one of D,N,C,E
  Predefined are:
  tempRule1: Mo-Fr 6:00,D 22:00,N
  tempRule2: Sa-So 8:00,D 22:00,N
  This results in tempDay 6:00-22:00 from Monday to Friday and tempNight outside this time window.
- desiredTempFrom
  This can be used as an alternative instead of the calculation of desired-temp based on the tempRules - which will happen when autoCalcTemp is set to '1'.
  (Either by removing the attribute autoCalcTemp or explicitly setting it to '1'.).
  If set correctly the desired-temp will be read from a reading of another device.
  Format is <device>[:<reading>[:<regexp>]]
  device defines the reference to the other object.
  reading defines the reading that contains the value for desired-temp. Default is 'desired-temp'.
  regexp defines a regular expression to extract the value used for 'desired-temp'. Default is '(\d[\d\.]+)'. If regexp does not match (e.g. reading is 'off') then tempFrostProtect is used.
  Internals c_desiredTempFrom reflects the actual setting and d_name, d_reading und d_regexpTemp the values used.
  If this attribute is used then state will change from "Calculating" to "From <device>".
  Calculation of desired-temp is (like when using tempRules) based on the interval specified for this device (default is 300 seconds).
- valueFormat
  Defines a map to format values within PWMR.
  The following reading can be formated using syntax of sprinf: temperature
  Example: { "temperature" => "%0.2f" }

### PW_Circles

The PW_Circles module is invoked by Plugwise. You need to define a Plugwise-Stick first. See Plugwise.
Define

`define <name> PW_Circle <ShortAddress>`
`<ShortAddress>`

specifies the short (last 4 Bytes) of the Circle received by the Plugwise-Stick.

Set

`on / off`

Turns the circle on or off

`on-for-timer / off-for-timer sec`

Turns the circle on or off for a given interval

`syncTime`

Syncronises the internal clock of the Circle with your PC's clock

`removeNode`

Removes this device from your Plugwise-network

`ping`

Ping the circle and write the Ping-Runtime to reading "ping" in format "q_in - q_out - pingTime"

`status`

Gets the current state of this cirle.

Attributes

`interval`

specifies the polling time for this circle

Example

`define Circle_2907CC9 PW_Circle 2907CC9`

### PW_Scan

The PW_Scan module is invoked by Plugwise. You need to define a Plugwise-Stick first. See PW_Scan.
Define

`define <name> PW_Scan <ShortAddress>`
`<ShortAddress>`

specifies the short (last 4 Bytes) of the PW_Scan received by the Plugwise-Stick.

Example:
`define PW_Scan_2907CC9 PW_Scan 2907CC9`

### PW_Sense

The PW_Sense module is invoked by Plugwise. You need to define a Plugwise-Stick first. See PW_Sense.
Define

`define <name> PW_Sense <ShortAddress>`
`<ShortAddress>`

specifies the short (last 4 Bytes) of the PW_Sense received by the Plugwise-Stick.

Example:
`define PW_Sense_2907CC9 PW_Sense 2907CC9`

### PW_Switch

The PW_Switch module is invoked by Plugwise. You need to define a Plugwise-Stick first. See PW_Switch.
Define

`define <name> PW_Switch <ShortAddress>`
`<ShortAddress>`

specifies the short (last 4 Bytes) of the Circle received by the Plugwise-Stick.

Example:
`define PW_Switch_2907CC9 PW_Switch 2907CC9`

Set

`syncTime`

Syncronises the internal clock of the Circle with your PC's clock

`removeNode`

Removes this device from your Plugwise-network

`ping`

Ping the circle and write the Ping-Runtime to reading "ping" in format "q_in - q_out - pingTime"

### PachLog

The PachLog-Module Logs SensorData like (temperature and humidity) to www.pachube.com.
Note: this module needs the HTTP::Request and LWP::UserAgent perl modules.
Define

`define <name> PachLog <Pachube-API-Key>`
<Pachube-API-Key>:
The Pachube-API-Key however is what you need in your code to authenticate your application's access the Pachube service.
Don't share this with anyone: it's just like any other password.
www.pachube.com

Set

Add a new Device for Logging to www.pachube.com
`set <NAME> ADD <FHEM-DEVICENAME> FEED-NR:ID:READING:ID:READING`
Example: KS300-Weather-Data
READINGS: temperature humidity wind rain
1. Generate Input-Feed on www.pachube.com => Yout get your FEED-NR: 1234
2. Add Datastreams to the Feed:

ID | 0 | temperature
ID | 1 | humidity
ID | 2 | wind
ID | 3 | rain

3. Add the KS300 to your PachLog-Device
`set <NAME> ADD <My-KS300> 1234:0temperature:1:humidity:2:wind:3:rain`
Delete a Device form Logging to www.pachube.com
`set <NAME> DEL <FHEM-DEVICENAME>`

Get

N/A

Attributes

- do_not_notify
- disable
  Disables PachLog. Nor more Logging to www.pachube.com

### Plugwise

This module is for the Plugwise-System.
Note: this module requires the Device::SerialPort or Win32::SerialPort module if the devices is connected via USB or a serial port. Also needed: digest:CRC You can install these modules using CPAN.
Define

`define <name> Plugwise <device>`

<device> specifies the serial port to communicate with the Plugwise-Stick. Normally on Linux the device will be named /dev/ttyUSBx, where x is a number. For example /dev/ttyUSB0. Please note that the Plugwise-Stick normally operates at 115200 baud. You may specify the baudrate used after the @ char.
Example:
`define myPlugwise Plugwise /dev/ttyPlugwise@115200`

Set

`Scan_Circles`

Initiates a scan for new devices and defines them.

`syncTime`

Syncs all reachable devices to the system-time.

`reOpen`

Closes and reopens the serial-Port. (useful in case of to many Errors)

Attributes

`circlecount`

Max. Number of Circles to be found by the Scan-Command

`interval`

standard polling-interval for new Circles

`autosync`

Sends every n seconds a SyncTime to each device

`WattFormat`

A string representing the format of the power-readings. If not defined, it defaults to %0.f

`showCom`

Writes the complete communication matching a RegEx into the reading "communication" (can be viewed in EventMonitor or used with a FileLog)

### PostMe

FHEM module to set up a system of sticky notes, similar to Post-Its™

#### Define

`define <postit> PostMe`
Defines the PostMe system, <postit> is an arbitrary name for the system.

#### Usage

See Wiki documentation
An arbitrary number of lists may be added to the system with the create command.
List items may consist of one or more words, and are added/removed by the add and remove command, but no separator characters are allowed in one item
Attention: A comma "," is the default separator for list items, see attributes below.

Meta data for items (=annotations)may be included in the items by using "[" and "]"; characters, e.g.
`set <postit> add <name> <item> [<attribute1>="<data1>" ...`
These attribute-value pairs may be added, modified and removed with the modify command.

Special annotations will be evaluated further, either on creation or manually by executing the commands
`get <postit> special <name>` resp. `get <postit> allspecial`

- The attribute at="<timespec/datespec>", when given a timespec/datespec value, will result in a single or multiple reminding messages for this item. The syntax for this timespec/datespec value is
  `(<HH:MM>|<HH:MM:SS>|<YYYY-MM-DD>T<HH:MM:SS>)[-<HH:MM>[P<number>]]`
  The first part is the time/date specification when the item is due.
  The second optional part beginning with a "-"-sign denotes how much time befor this date you want to be alerted.
  The third optional part beginning with a "P" character allows to specify a <number> of periodic reminders, the period given by the second part.
  Processing this attribute means, that several at devices will be set up in the room hidden that are triggered when at the specified times. See documentation in Wiki for examples.
- The attribute notify="<eventspec>", when given an eventspec value, will result in a single or multiple reminding messages for this item.
  Processing this attribute means, that a notify device will be set up in the room hidden that is triggered when the event is detected.

The sticky notes may be integrated into any Web page by simply embedding the following tags

- `<embed src="/fhem/PostMe_widget?type=pins&postit=<postit>"/>`
  to produce an interactive list of all PostMe names with pins from system <postit>.
- `<embed src="/fhem/PostMe_widget?type=pin&postit=<postit>&name=<name>"/>`
  to produce an interactive entry for PostMe <name>from system <postit>

The module provides interface routines that may be called from your own Perl programs, see documentation in the Wiki.

#### Set

- `set <postit> create <name>`
  creates a sticky note named <name>
- `set <postit> rename <name> <newname>`
  renames the sticky note named <name> as <newname>
- `set <postit> delete <name>`
  deletes the sticky note named <name>
- `set <postit> add <name> <item>`
  adds to the sticky note named <name> an item <item>
- `set <postit> modify <name> <item> <attribute> <data>`
  adds/modifies/removes and attribute-value-pair <attribute>="<data>" to the item <item> on the sticky note named <name>
  adding, if this attribute is not yet present; modification, if it is present - <data> will then be overwritten; removal, if no <data> is given
- `set <postit> remove <name> <item>`
  `set <postit> remove <name> item<number>`
  removes from the sticky note named <name> an item <item> or the one numbered <number> (starting at 0)
- `set <postit> clear <name>`
  clears the sticky note named <name> from all items

#### Get

- `get <postit> list <name>`
  Show the sticky note named <name> and its content
- `get <postit> special <name>`
  Process the special annotations (see above) of the sticky note named <name>
- `get <postit> mail <name>`
  Send the sticky note named <name> and its content via eMail to a predefined recipient (e.g. sticky note <postme01Name> is sent to <postme01MailRec>).
  The mailing subroutine <postmeMsgFun> is called with three parameters for recipient, subject and text.
- `get <postit> message <name>`
  Send the sticky note named <name> and its content via instant messenger to a predefined recipient (e.g. sticky note <postme01Name> is sent to <postme01MsgRec>).
  The messenger subroutine <postmeMsgFun> is called with three parameters for recipient, subject and text.
- `get <postit> TTS <name>`
  Speak the sticky note named <name> and its content. The TTS subroutine <postmeTTSFun> is called with one parameter text.
- `get <postit> JSON <name>`
  Return the sticky note named <name> in JSON format
- `get <postit> all`
  Show all sticky notes and their content
- `get <postit> allspecial`
  Process the special annotations (see above) of all sticky notes
- `get <postit> version`
  Display the version of the module

#### Attributes

- `attr <postit> postmeStd <name1,name2,...>`
  Comma separated list of standard sticky notes that will be created on device start.
- `attr <postit> postmeClick 1|0 (default)`
  If 0, embedded sticky notes will pop up on mouseover-events and vanish on mouseout-events (default).
  If 1, embedded sticky notes will pop up on click events and vanish after closing the note
- `attr <postit> postmeIcon <string>`
  Icon for display of a sticky note
- `attr <postit> postmeStyle SVG|HTML|jQuery (default)`
  If jQuery, embedded sticky notes will produce jQuery code (default)
  If HTML, embedded sticky notes will produce HTML code
  If SVG, embedded sticky notes will produce SVG code
- `attr <postit> listseparator <character>`
  Character used to separate list items (default ',')

Note, that in the parameters sent to the following functions, ":" serves as separator between list name and items, and "," serves as separator between items. They may be exchanged with simple regular expression operations.

- `attr <postit> postmeMailFun <string>`
  Function name for the eMail function. This subroutine is called with three parameters for recipient, subject and text.
- `attr <postit> postmeMailRec(01|02|...) <string>` recipient addresses for the above eMail function (per PostMe).
- `attr <postit> postmeMsgFun <string>`
  Function name for the instant messenger function. This subroutine is called with three parameters for recipient, subject and text.
- `attr <postit> postmeMsgRec(01|02|...) <string>` recipient addresses for the above instant messenger function (per PostMe).
- `attr <postit> postmeTTSFun <string>`
  Function name for the text-to-speech function. This subroutine is called with two parameters, the device name and the composite text.
- `attr <postit> postmeTTSDev(01|02|...) <string>` device name for the above TTS function.
- Standard attributes alias, comment, event-on-update-reading, event-on-change-reading, room, eventMap, loglevel, webCmd

### PushNotifier

PushNotifier is a service to receive instant push notifications on your phone or tablet from a variety of sources.
You need an account to use this module.
For further information about the service see FhemWiki PushNotifier.
Discuss the module here.
Define

`define <name> PushNotifier <apiToken> <appName> <user> <password> <deviceID>`
You have to create an account to get the apiToken.
And you have to create an application to get the appToken.
Example:

`define PushNotifier1 PushNotifier 01234 appname user password 012`

Set

`set <PushNotifier_device> message`
Examples:

`set PushNotifier1 message This is a text.`

Linebreak:

`set PushNotifier1 message This is a text._New Line.`

Generated events:

N/A

### Pushalot

Pushalot is a service to receive instant push notifications on your Windows Phone device from a variety of sources.
You need an account to use this module.
For further information about the service see pushalot.com.
Discuss the module here.
Define

`define <name> Pushalot <token> [<source>]`

<token> | The token that identifies a pushalot-account. You need to create if no account yet.
<source> | The source defines what will be shown in the 'from'-field of the message (the sender).

Example:

`define PushNotification Pushalot 123234 FHEM`

Set

`set <Pushalot_device> "<message>" ["<title>"] ["<image>"] ["<link>"] ["<link_title>"] ["<important>"] ["<silent>"]`

<message> | The message body that should appear in the message.
<title> | The title of the message.
<image> | An optional image URL that is shown in the message.
<link> | An optional link that should be appended to the message body.
<link_title> | An optional link title. If no title is set, the URL is shown as title in the message.
<important> | True|False: True if the message should be marked as 'important', otherwise False (Default)
<silent> | True|False: True if the message should be delivered silently (no notify sound is played), otherwise False (Default)
<time_to_live> | The time in minutes after which the message is automatically purged

Examples:

`set PushNotification message "This is my message."`
`set PushNotification message "This is my message." "With Title"`
`set PushNotification message "This is my message." "With Title" "http://www.xyz.com/image.png"`
`set PushNotification message "This is my message." "With Title" "http://www.xyz.com/image.png" "http://www.xyz.com"`
`set PushNotification message "This is my message." "With Title" "http://www.xyz.com/image.png" "http://www.xyz.com" "Link Title"`
`set PushNotification message "This is my message." "With Title" "http://www.xyz.com/image.png" "http://www.xyz.com" "Link Title" True`
`set PushNotification message "This is my message." "With Title" "http://www.xyz.com/image.png" "http://www.xyz.com" "Link Title" True False`
`set PushNotification message "This is my message." "With Title" "http://www.xyz.com/image.png" "http://www.xyz.com" "Link Title" True False 5`

Get

N/A

Attributes

N/A

Generated events:

N/A

### Pushbullet

Pushbullet is a service to send instant push notifications to different devices. There are apps for iPhone, Android, Windows (Beta), Mac OS X and plugins for Chrome Firefox and Safari.
For further information about the service see pushbullet.com.
Discuss the module here.
Define

`define <name> Pushbullet <accessToken>`
Note:

- JSON has to be installed on the FHEM host.
- Register on pushbullet.com to get your accessToken.

Set

- clear
  clear device readings
- contactAdd name | email
  adds a contact. Spaces in name are allowed
- deviceDelete deviceName
  deletes a device
- deviceRename deviceName | newDeviceName
  renames a device
- link [| title | device]
  sends a link with optional title and device. If no device is given, push goes to all your devices.
- list item1[, item2, item3, ... | title | device]
  sends a list with one or more items, optional title and device. If no device is given, push goes to all your devices.
- message [| title | device]
  sends a push notification with optional title and device. If no device is given, push goes to all your devices.
Examples:

`set Pushbullet message This is a message.`
sends a push notification with message "This is a message" without a title to all your devices.
`set Pushbullet message This is a message | A title`
sends a push notification with message "This is a message" and title "A title" to all your devices.
`set Pushbullet message This is a message | A title | iPhone`
sends a push notification with message "This is a message" and title "A title" to Device iPhone.
`set Pushbullet message This is a message | A title | Max Mustermann`
sends a push notification with message "This is a message" and title "A title" to your contact Max Mustermann.

Note:
Spaces before and after | are not needed.

Get

- devices
  reads your device list (devices + contacts) and set device readings

Attributes

- defaultDevice
  default device for pushmessages
- defaultTitle
  default title for pushmessages. If it is undefined the defaultTitle will be FHEM

### Pushover

Pushover is a service to receive instant push notifications on your phone or tablet from a variety of sources.
You need an account to use this module.
For further information about the service see pushover.net.
Installation of Perl module IO::Socket::SSL is mandatory to use this module (i.e. via 'cpan -i IO::Socket::SSL').
It is recommended to install Perl-JSON to make use of advanced functions like supplementary URLs.
Discuss the module here.
Define

`define <name> Pushover <token> <user> [<infix>]`
You have to create an account to get the user key.
And you have to create an application to get the API token.
Attribute infix is optional to define FHEMWEB uri name for Pushover API callback function.
Callback URL may be set using attribute callbackUrl (see below).
Note: A uri name can only be used once within each FHEM instance!
Example:

`define Pushover1 Pushover 01234 56789`

`define Pushover1 Pushover 01234 56789 pushCallback1`

Set

msg

`set <Pushover_device> msg <text> [<option1>=<value> <option2>="<value with space in it>" ...]`
The following options may be used to adjust message content and delivery behavior:
`message` - type: text - Your message text. Using this option takes precedence; non-option text content will be discarded.
`device` - type: text - Your user's device name to send the message directly to that device, rather than all of the user's devices (multiple devices may be separated by a comma). May also be set to a specific User or Group Key. To address a specific device for a specific User/Group, use User/Group Key first and add device name separated by colon.
`title` - type: text - Your message's title, otherwise your Pushover API app's name is used.
`action` - type: text - Either a FHEM command to run when user taps link or a supplementary URL to show with your message.
`url_title` - type: text - A title for your FHEM command or supplementary URL, otherwise just the URL is shown.
`priority` - type: integer - Send as -2 to generate no notification/alert, -1 to always send as a quiet notification, 1 to display as high-priority and bypass the user's quiet hours, or 2 to also require confirmation from the user.
`retry` - type: integer - Mandatory in combination with message priority >= 2.
`expire` - type: integer - Mandatory in combination with message priority >= 2.
`timestamp` - type: integer - A Unix timestamp of your message's date and time to display to the user, rather than the time your message is received by the Pushover servers. Takes precendence over attribute timestamp=1.
`sound` - type: text - The name of one of the sounds supported by device clients to override the user's default sound choice.
Examples:

`set Pushover1 msg My first Pushover message.`
`set Pushover1 msg My second Pushover message.\nThis time with two lines.`
`set Pushover1 msg "Another Pushover message in double quotes."`
`set Pushover1 msg 'Another Pushover message in single quotes.'`
`set Pushover1 msg message="Pushover message using explicit option for text content." This part of the text will be ignored.`
`set Pushover1 msg This is a message with a title. title="This is a subject"`
`set Pushover1 msg title="This is a subject, too!" This is another message with a title set at the beginning of the command.`
`set Pushover1 msg title=Emergency priority=2 retry=30 expire=3600 Security issue in living room.`
`set Pushover1 msg title=Link Have a look to this website: url_title="Open" action="http://fhem.de/" expire=3600`
`set Pushover1 msg title=Hint expire=3600 This is a reminder to do something. Action will expire in 1h. url_title="Click here for action" action="set device something"`
`set Pushover1 msg title=Emergency priority=2 retry=30 expire=3600 Security issue in living room. sound=siren url_title="Click here for action" action="set device something"`

msg (deprecated format)

`set <Pushover_device> msg [title] <msg> [<device> <priority> <sound> [<retry> <expire> [<url_title> <action>]]]`
Examples:

`set Pushover1 msg 'This is a text.'`
`set Pushover1 msg 'Title' 'This is a text.'`
`set Pushover1 msg 'Title' 'This is a text.' '' 0 ''`
`set Pushover1 msg 'Emergency' 'Security issue in living room.' '' 2 'siren' 30 3600`
`set Pushover1 msg 'Hint' 'This is a reminder to do something' '' 0 '' 0 3600 'Click here for action' 'set device something'`
`set Pushover1 msg 'Emergency' 'Security issue in living room.' '' 2 'siren' 30 3600 'Click here for action' 'set device something'`

Notes:

- For the first and the second example the corresponding default attributes for the missing arguments must be defined for the device (see attributes section)
- If device is empty, the message will be sent to all devices.
- If device has a User or Group Key, the message will be sent to this recipient instead. Should you wish to address a specific device here, add it at the end separated by colon.
- If sound is empty, the default setting in the app will be used.
- If priority is higher or equal 2, retry and expire must be defined.

glance

`set <Pushover_device> glance [<text>] [<option1>=<value> <option2>="<value with space in it>" ...]`
Update Pushover's glances on Apple Watch.
The following options may be used to adjust message content and delivery behavior:
`title` - type: text(100 characters) - A description of the data being shown, such as "Widgets Sold".
`text` - type: text(100 characters) - The main line of data, used on most screens. Using this option takes precedence; non-option text content will be discarded.
`subtext` - type: text(100 characters) - A second line of data.
`count` - type: integer(may be negative) - Shown on smaller screens; useful for simple counts.
`percent` - type: integer(0-100) - Shown on some screens as a progress bar/circle.
`device` - type: text - Your user's device name to send the message directly to that device, rather than all of the user's devices (multiple devices may be separated by a comma). May also be set to a specific User or Group Key. To address a specific device for a specific User/Group, use User/Group Key first and add device name separated by colon.

Get

N/A

Attributes

- do_not_notify
- disabledForIntervals
- readingFnAttributes
- `callbackUrl`
  Set the callback URL to be used to acknowledge messages with emergency priority or supplementary URLs.
- `timestamp`
  Send the unix timestamp with each message.
- `title`
  Will be used as title if title is not specified as an argument.
- `device`
  Will be used for the device name if device is not specified as an argument. If left blank, the message will be sent to all devices.
- `priority`
  Will be used as priority value if priority is not specified as an argument. Valid values are -1 = silent / 0 = normal priority / 1 = high priority
- `sound`
  Will be used as the default sound if sound argument is missing. If left blank the adjusted sound of the app will be used.

Generated events:

N/A

### Pushsafer

Pushsafer is a web service to receive instant push notifications on your iOS, Android or Windows 10 Phone or Desktop device from a variety of sources.
You need a Pushsafer account to use this module.
For further information about the service see pushsafer.com.
This module is only capable to send messages via Pushsafer.
Define

`define <name> Pushsafer <key>`
The parameter <key> must be a alphanumeric string. This can be a regular private key (20 digits) from your Pushsafer account or an E-Mail alias key (15 digits) which needs to be setup in your account.
Example:

`define PushsaferAccount Pushsafer A1b2c3D4E5F6g7h8i9J0`

Set

`set <name> message <text> [<option1>=<value> <option2>=<value> ...]`
Currently only the message command is available to sent a message.
So the very basic use case is to send a simple text message like the following example:
`set PushsaferAccount message "My first Pushsafer message."`
To send a multiline message, use the placeholder "\n" to indicate a newline:
`set PushsaferAccount message "My second Pushsafer message.\nThis time with two lines."`
Optional Modifiers
It is possible to customize a message with special options that can be given in the message command after the message text. Several options can be combined together. The possible options are:
`title` - short: `t` - type: text - A special title for the message text.
`device` - short: `d` - type: text - The device ID as number, to send the message to a specific device, or "gs" + group ID to send to a device group (e.g. "gs23" for group id 23). By default the message will be send to all registered devices.
`sound` - short: `s` - type: number - The ID of a specific sound to play on the target device upon reception (see Pushsafer.com for a complete list of values and their meaning).
`icon` - short: `i` - type: number - The ID of a specific icon to show on the target device for this text (see Pushsafer.com for a complete list of values and their meaning).
`vibration` - short: `v` - type: number - The number of times the device should vibrate upon reception (maximum: 3 times; iOS/Android only). If not set, the default behavior of the device is used.
`url` - short: `u` - type: text - A URL that should be included in the message. This can be regular http:// URL's but also specific app schemas. See Pushsafer.com for a complete list of supported URL schemas.
`urlText` - short: `ut` - type: text - A text that should be used to display a URL from the "url" option.
`key` - short: `k` - type: text - Overrides the private key given in the define statement. Also an alias key can be used.
`ttl` - short: `l` - type: number - Defines a "time-to-live" given in minutes after the message will be deleted on the target device(s). Possible range is between 1 - 43200 minutes (30 days).
`picture` - short: `p` - type: text - Attach a image to the message. This can be a file path located in your filesystem (e.g. `picture=/home/user/picture.jpg`) or the name of a IPCAM instance (like `picture=IPCAM:<name>`) to send the last snapshot image (e.g. `picture=IPCAM:IpCam_Front_House`). The supported image formats are JPG, PNG and GIF.
`picture2` - short: `p2` - type: text - same syntax as for option `"picture"`
`picture3` - short: `p3` - type: text - same syntax as for option `"picture"`
Examples:

`set PushsaferAccount message "This is a message with a title." title="Super important"`
`set PushsaferAccount message "Get down here\nWe're waiting" title="Lunch is ready" device=100`
`set PushsaferAccount message "Server is down" sound=25 icon=5 vibration=3`
`set PushsaferAccount message "Look at my photos" url="http://www.foo.com/myphotos" urlText="Summer Vacation"`
It is also possible to use the short-term versions of options:
`set PushsaferAccount message "This is a message with a title." t="Super important"`
`set PushsaferAccount message "Get down here\nWe're waiting" t="Lunch is ready" d=100`
`set PushsaferAccount message "Server is down" s=25 i=5 v=3`
`set PushsaferAccount message "Look at my photos" u="http://www.foo.com/myphotos" ut="Summer Vacation"`

Get

N/A

Attributes

- do_not_notify
- disabledForIntervals
- readingFnAttributes

Generated Readings/Events:

- lastSuccess - The last successful status message received by the Pushsafer server
- lastError - The last errur message received by the Pushsafer server
- availableMessages-<device ID>-<device name> - The remaining messages that can be send to this device

### QRCode

Devices of this module are used to generate an URL that will be used to generate and receive a QRCode from the service of TEC-IT
The device will also display the generated QRCode in the device details. It can also provide the HTML-code used for display for other purposes (e.g. weblink devices)
ATTENTION:The sevice provider does not allow more than 30 QRCode generations / minute without special permission
See terms of sevice on TEC-IT homepage: http://qrcode.tec-it.com/de#TOS
Define

`define <name> QRCode`

Set

`set <name> update`
Refreshes the QRCode-URL for Image generation.

Attributes

QRCode-URL relevant attributes
The following attributes take influence on the QRCode generation.
If one of those attributes is changed, per default an auto update of the QRCode-URL is performed.
- qrData
  This attribute is used to set the data that will be encoded in the QRCode.
  If this attribute is not set an error message is generatet.
- qrSize
  Defines the size of the generated QRCode image
  Possible values are small, medium (default), large.
- qrResolutionDPI
  Defines the resolution for QRCode generaation
  Valid values are between 96 and 600 (Default is 300dpi)
- qrColor
  Defines the foreground color of the genereted QRCode image
  This is a RGB color value in hex format (eg. FF0000 = red) Default is 000000 (black)
- qrBackColor
  Defines the background color of the genereted QRCode image
  This is a RGB color value in hex format (eg. 0000FF = blue) Default is FFFFFF (white).
- qrTransparent
  Defines that the background of the generated QRCode will be transparent
  Possible values are False (non-tranparent background) or True (transparent background)
  default is non-transparent.
- qrQuietZone
  defines the size of a quiet zone around the QRCode in the image.
  This is a blank zone making it easier to scan the QRCode for some scanners.
  Default ist 0, if attribute is not set.
- qrQuietUnit
  specifies the unit for qrQuietZone attribute
  Possible values are mm (default), in (=inch), mil (=mils), mod (=Module) or px (=Pixel).
- qrCodepage
  Used Codepage for QRCode generation.
  Possible values are UTF8 (default), Cyrillic or Ansi
- qrErrorCorrection
  Error correction used in generated QRCode image.
  Possible values are L (default), M,Q or H
Display relevant attributes
The followin Attribute change the behaviour and display parameters for the detail view
of QRCode devices in FHEMWEB. Therfore it changes the result of QRCode_getHtml function
(see below.)
In cas of an error, neither QRCode, nor qrDisplayText will be displayed. Instead
an error message is displayed.
- qrDisplayWidth
  display width of the QRCode image
  Default is 200
- qrDisplayHeight
  Display height of the QRCode image
  Default is 200
- qrDisplayData
  If set the contents or the reading data is displayed below the QRCode image
  Usually this is the contents of attribute qrData.
- qrDisplaNoImage
  If set, the QRCode image will not be displayed
- qrDisplaText
  user defined text to be displayed below QRCode image
- qrDisplaNoText
  If this attribute is set, the text specified in qrDisplayText will not be displayed
  below QRCode image. So qrDisplayText doesn't have to be deleted.
- qrNoAutoUpdate
  If set not auto update will be processed for QRCode relevant attributes.
- readingFnAttributes

Generated Readings

- data
  This reading contains the data to be encoded by the QRCode
  Usually this is the contents of attribute qrData.
  In case of an error it contains the error message.
- qrcode_url
  By `set update` generated URL, used to get the QRCode image
- state
  The state of the device
  Initially this is `defined` or the timestamp of last `set update`, or auto-update

Usefull Funktionen
The module comes with a useful function to provide the HTML code used for display in detail view of the
QRCode device in FHEMWEB for other purposes, e.g. weblink.

- `QRCode_getHtml($;$$)`
  Returns the HTML code for the specified QRCode device
  Arguments:
  - QRCodeDevice
    Name of the QRCode device as a string.
  - noImage (Optional)
    The same as attribute qrDisplayNoImage
  - noText (Optional)
    The same as attribute qrDisplayNoText
  Example:
  `QRCode_getHtml('MyQRCode',1,0)`
  Generate HTML code of (QRCode-) device named MyQRCode with QRCode image but not with the
  user defined Text (qrDisplayText).

### RESIDENTS

Define

`define <rgr_ResidentsName> RESIDENTS`
Provides a special virtual device to represent a group of individuals living at your home.
It locically combines individual states of ROOMMATE and GUEST devices and allows state changes for all members.
Based on the current state and other readings, you may trigger other actions within FHEM.
Example:

`# Standalone
define rgr_Residents RESIDENTS`

Set

`set <rgr_ResidentsName> <command> [<parameter>]`
Currently, the following commands are defined.

- addGuest - creates a new GUEST device and adds it to the current RESIDENTS group. Just enter the dummy name and there you go.
- addRoommate - creates a new ROOMMATE device and adds it to the current RESIDENTS group. Just enter the first name and there you go.
- removeGuest - shows all GUEST members and allows to delete their dummy devices easily.
- removeRoommate - shows all ROOMMATE members and allows to delete their dummy devices easily.
- state home,gotosleep,asleep,awoken,absent,gone switch between states for all group members at once; see attribute rgr_states to adjust list shown in FHEMWEB
- create wakeuptimer add several pre-configurations provided by RESIDENTS Toolkit. See separate section for details.

Note: If you would like to restrict access to admin set-commands (-> addGuest, addRoommate, removeGuest, create) 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.

Possible states and their meaning

This module differs between 7 states:

- home - residents are present at home and at least one of them is not asleep
- gotosleep - present residents are on their way to bed (if they are not asleep already)
- asleep - all present residents are currently sleeping
- awoken - at least one resident just woke up from sleep
- absent - no resident is currently at home but at least one will be back shortly
- gone - all residents left home for longer period
- none - no active member

Note: State 'none' cannot explicitly be set. Setting state to 'gone' will be handled as 'none' for GUEST member devices.

Attributes

- rgr_showAllStates - states 'asleep' and 'awoken' are hidden by default to allow simple gotosleep process via devStateIcon; defaults to 0
- rgr_states - list of states to be shown in FHEMWEB; separate entries by comma only and do NOT use spaces; unsupported states will lead to errors though
- rgr_wakeupDevice - reference to enslaved DUMMY devices used as a wake-up timer (part of RESIDENTS Toolkit's wakeuptimer)

Generated Readings/Events:

- lastActivity - the last state change of one of the group members
- lastActivityBy - the realname of the last group member with changed state
- lastArrival - timestamp of last arrival at home
- lastAwake - timestamp of last sleep cycle end
- lastDeparture - timestamp of last departure from home
- lastDurAbsence - duration of last absence from home in human readable format (hours:minutes:seconds)
- lastDurAbsence_cr - duration of last absence from home in computer readable format (minutes)
- lastDurPresence - duration of last presence at home in human readable format (hours:minutes:seconds)
- lastDurPresence_cr - duration of last presence at home in computer readable format (minutes)
- lastDurSleep - duration of last sleep in human readable format (hours:minutes:seconds)
- lastDurSleep_cr - duration of last sleep in computer readable format (minutes)
- lastSleep - timestamp of last sleep cycle begin
- lastState - the prior state
- lastWakeup - time of last wake-up timer run
- lastWakeupDev - device name of last wake-up timer
- nextWakeup - time of next wake-up program run
- nextWakeupDev - device name for next wake-up program run
- presence - reflects the home presence state, depending on value of reading 'state' (can be 'present' or 'absent')
- residentsAbsent - number of residents with state 'absent'
- residentsAbsentDevs - device name of residents with state 'absent'
- residentsAbsentNames - device alias of residents with state 'absent'
- residentsAsleep - number of residents with state 'asleep'
- residentsAsleepDevs - device name of residents with state 'asleep'
- residentsAsleepNames - device alias of residents with state 'asleep'
- residentsAwoken - number of residents with state 'awoken'
- residentsAwokenDevs - device name of residents with state 'awoken'
- residentsAwokenNames - device alias of residents with state 'awoken'
- residentsGone - number of residents with state 'gone'
- residentsGoneDevs - device name of residents with state 'gone'
- residentsGoneNames - device alias of residents with state 'gone'
- residentsGotosleep - number of residents with state 'gotosleep'
- residentsGotosleepDevs - device name of residents with state 'gotosleep'
- residentsGotosleepNames - device alias of residents with state 'gotosleep'
- residentsHome - number of residents with state 'home'
- residentsHomeDevs - device name of residents with state 'home'
- residentsHomeNames - device alias of residents with state 'home'
- residentsTotal - total number of all active residents despite their current state
- residentsTotalAbsent - number of all residents who are currently underway
- residentsTotalAbsentDevs - device name of all residents who are currently underway
- residentsTotalAbsentNames - device alias of all residents who are currently underway
- residentsTotalGuests - number of active guests who are currently treated as part of the residents scope
- residentsTotalGuestsAbsent - number of all active guests who are currently underway
- residentsTotalGuestsAbsentDevs - device name of all active guests who are currently underway
- residentsTotalGuestsAbsentNames - device alias of all active guests who are currently underway
- residentsTotalGuestsPresent - number of all active guests who are currently at home
- residentsTotalGuestsPresentDevs - device name of all active guests who are currently at home
- residentsTotalGuestsPresentNames - device alias of all active guests who are currently at home
- residentsTotalRoommates - number of residents treated as being a permanent resident
- residentsTotalRoommatesAbsent - number of all roommates who are currently underway
- residentsTotalRoommatesAbsentDevs - device name of all roommates who are currently underway
- residentsTotalRoommatesAbsentNames - device alias of all roommates who are currently underway
- residentsTotalRoommatesPresent - number of all roommates who are currently at home
- residentsTotalRoommatesPresentDevs - device name of all roommates who are currently at home
- residentsTotalRoommatesPresentNames - device alias of all roommates who are currently at home
- residentsTotalPresent - number of all residents who are currently at home
- residentsTotalPresentDevs - device name of all residents who are currently at home
- residentsTotalPresentNames - device alias of all residents who are currently at home
- residentsTotalWakeup - number of all residents which currently have a wake-up program being executed
- residentsTotalWakeupDevs - device name of all residents which currently have a wake-up program being executed
- residentsTotalWakeupNames - device alias of all residents which currently have a wake-up program being executed
- residentsTotalWayhome - number of all active residents who are currently on their way back home
- residentsTotalWayhomeDevs - device name of all active residents who are currently on their way back home
- residentsTotalWayhomeNames - device alias of all active residents who are currently on their way back home
- residentsTotalWayhomeDelayed - number of all residents who are delayed on their way back home
- residentsTotalWayhomeDelayedDevs - device name of all delayed residents who are currently on their way back home
- residentsTotalWayhomeDelayedNames - device alias of all delayed residents who are currently on their way back home
- state - reflects the current state
- wakeup - becomes '1' while a wake-up program of this resident group is being executed

RESIDENTS Toolkit

Using set-command `create` you may add pre-configured configurations to your RESIDENTS, ROOMMATE or GUEST devices for your convenience.
The following commands are currently available:
- wakeuptimer - adds a wake-up timer dummy device with enhanced functions to start with wake-up automations
  A notify device is created to be used as a Macro to carry out your actual automations. The macro is triggered by a normal at device you may customize as well. However, a special RESIDENTS Toolkit function is handling the wake-up trigger event for you.
  The time of activated wake-up timers may be relatively increased or decreased by using +<MINUTES> or -<MINUTES> respectively. +HH:MM can be used as well.
  The wake-up behaviour may be influenced by the following device attributes:
  - wakeupAtdevice - backlink the at device (mandatory)
  - wakeupDays - only trigger macro at these days. Mon=1,Tue=2,Wed=3,Thu=4,Fri=5,Sat=6,Sun=0 (optional)
  - wakeupDefaultTime - after triggering macro reset the wake-up time to this default value (optional)
  - wakeupEnforced - Enforce wake-up (optional; 0=no, 1=yes, 2=if wake-up time is not wakeupDefaultTime)
  - wakeupHolidays - May trigger macro on holidays or non-holidays (optional; andHoliday=on holidays also considering wakeupDays, orHoliday=on holidays independently of wakeupDays, andNoHoliday=on non-holidays also considering wakeupDays, orNoHoliday=on non-holidays independently of wakeupDays)
  - wakeupMacro - name of the notify macro device (mandatory)
  - wakeupOffset - value in minutes to trigger your macro earlier than the user requested to be woken up, e.g. if you have a complex wake-up program over 30 minutes (defaults to 0)
  - wakeupResetSwitcher - DUMMY device to quickly turn on/off reset function (optional, device will be auto-created)
  - wakeupResetdays - if wakeupDefaultTime is set you may restrict timer reset to specific days only. Mon=1,Tue=2,Wed=3,Thu=4,Fri=5,Sat=6,Sun=0 (optional)
  - wakeupUserdevice - backlink to RESIDENTS, ROOMMATE or GUEST device to check it's status (mandatory)
  - wakeupWaitPeriod - waiting period threshold in minutes until wake-up program may be triggered again, e.g. if you manually set an earlier wake-up time than normal while using wakeupDefaultTime. Does not apply in case wake-up time was changed during this period; defaults to 360 minutes / 6h (optional)

### RFXCOM

This module is for the old RFXCOM USB or LAN based 433 Mhz RF receivers and transmitters (order order code 80002 and others). It does not support the new RFXtrx433 transmitter because it uses a different protocol. See RFXTRX for support of the RFXtrx433 transmitter.
These receivers supports many protocols like Oregon Scientific weather sensors, RFXMeter devices, X10 security and lighting devices and others.
Currently the following parser modules are implemented:

- 41_OREGON.pm (see device OREGON): Process messages Oregon Scientific weather sensors. See http://www.rfxcom.com/oregon.htm of Oregon Scientific weather sensors that could be received by the RFXCOM receivers. Until now the following Oregon Scientific weather sensors have been tested successfully: BTHR918, BTHR918N, PCR800, RGR918, THGR228N, THGR810, THR128, THWR288A, WTGR800, WGR918. It will probably work with many other Oregon sensors supported by RFXCOM receivers. Please give feedback if you use other sensors.
- 42_RFXMETER.pm (see device RFXMETER): Process RFXCOM RFXMeter devices. See http://www.rfxcom.com/sensors.htm.
- 43_RFXX10REC.pm (see device RFXX10REC): Process X10 security and X10 lighting devices.

Note: this module requires the Device::SerialPort or Win32::SerialPort module if the devices is connected via USB or a serial port.
Define

`define <name> RFXCOM <device> [noinit]`

USB-connected (80002):

<device> specifies the USB port to communicate with the RFXCOM receiver. Normally on Linux the device will be named /dev/ttyUSBx, where x is a number. For example /dev/ttyUSB0.
Example:
`define RFXCOMUSB RFXCOM /dev/ttyUSB0`

Network-connected devices:

<device> specifies the host:port of the device. E.g. 192.168.1.5:10001

noninit is optional and issues that the RFXCOM device should not be initialized. This is useful if you share a RFXCOM device. It is also useful for testing to simulate a RFXCOM receiver via netcat or via FHEM2FHEM.
Example:
`define RFXCOMTCP RFXCOM 192.168.1.5:10001`
`define RFXCOMTCP2 RFXCOM 192.168.1.121:10001 noinit`

- dummy
- longids
  Comma separated list of device-types for RFXCOM that should be handled using long IDs. This additional ID is a one byte hex string and is generated by the Oregon sensor when is it powered on. The value seems to be randomly generated. This has the advantage that you may use more than one Oregon sensor of the same type even if it has no switch to set a sensor id. For example the author uses two BTHR918N sensors at the same time. All have different deviceids. The drawback is that the deviceid changes after changing batteries. All devices listed as longids will get an additional one byte hex string appended to the device name.
  Default is to use long IDs for all devices.
  Examples:

      # Do not use any long IDs for any devices:
      attr RFXCOMUSB longids 0
      # Use any long IDs for all devices (this is default):
      attr RFXCOMUSB longids 1
      # Use longids for BTHR918N devices.
      # Will generate devices names like BTHR918N_f3.
      attr RFXCOMUSB longids BTHR918N
      # Use longids for TX3_T and TX3_H devices.
      # Will generate devices names like TX3_T_07, TX3_T_01 ,TX3_H_07.
      attr RFXCOMUSB longids TX3_T,TX3_H

### RFXMETER

The RFXMETER module interprets RFXCOM RFXMeter messages received by a RFXCOM receiver. You need to define an RFXCOM receiver first. See the RFXCOM.
Define

`define <name> RFXMETER <deviceid> [<scalefactor>] [<unitname>]`
<deviceid> is the device identifier of the RFXMeter sensor and is a one byte hexstring (00-ff).
<scalefactor> is an optional scaling factor. It is multiplied to the value that is received from the RFXmeter sensor.
<unitname> is an optional string that describes the value units. It is added to the Reading generated to describe the values.
Example:
`define RFXWater RFXMETER 00 0.5 ltr`
`define RFXPower RFXMETER 01 0.001 kwh`
`define RFXGas RFXMETER 02 0.01 cu_m`

Set

N/A

Get

N/A

Attributes

- ignore
- do_not_notify

### RFXX10REC

The RFXX10REC module interprets X10 security and X10 lighting messages received by a RFXCOM RF receiver. Reported also to work with KlikAanKlikUit. You need to define an RFXCOM receiver first. See RFXCOM.
Define

`define <name> RFXX10REC <type> <deviceid> <devicelog> [<deviceid> <devicelog>]`
`<type>`

specifies the type of the X10 device:
X10 security devices:

- `ds10a` (X10 security ds10a Door/Window Sensor or compatible devices. This device type reports the status of the switch [Open/Closed], status of the delay switch [min|max]], and battery status [ok|low].)
- `ms10a` (X10 security ms10a motion sensor. This device type reports the status of motion sensor [normal|alert] and battery status [ok|low].))
- `sd90` (Marmitek sd90 smoke detector. This device type reports the status of the smoke detector [normal|alert] and battery status [ok|low].)
- `kr18` (X10 security remote control. Report the Reading "Security" with values [Arm|Disarm], "ButtonA" and "ButtonB" with values [on|off] )

X10 lighting devices:

- `ms14a` (X10 motion sensor. Reports [normal|alert] on the first deviceid (motion sensor) and [on|off] for the second deviceid (light sensor))
- `x10` (All other x10 devices. Report [on|off] on both deviceids.)

`<deviceid>`

specifies the first device id of the device. X10 security have a a 16-Bit device id which has to be written as a hex-string (example "5a54"). A X10 lighting device has a house code A..P followed by a unitcode 1..16 (example "B1").

`<devicelog>`

is the name of the Reading used to report. Suggested: "Window" or "Door" for ds10a, "motion" for motion sensors, "Smoke" for sd90.

`<deviceid2>`

is optional and specifies the second device id of the device if it exists. For example sd90 smoke sensors can be configured to report two device ids. ms14a motion sensors report motion status on the first deviceid and the status of the light sensor on the second deviceid.

`<devicelog2>`

is optional for the name used for the Reading of `<deviceid2>`.

Example:
`define livingroom_window RFXX10REC ds10a 72cd Window`
`define motion_sensor1 RFXX10REC ms10a 55c6 motion`
`define smoke_sensor1 RFXX10REC sd90 54d3 Smoke 54d3 Smoketest`
`define motion_sensor2 RFXX10REC ms14a A1 motion A2 light`

Set

N/A

Get

N/A

Attributes

- ignore
- do_not_notify

### ROOMMATE

Define

`define <rr_FirstName> ROOMMATE [<device name(s) of resident group(s)>]`
Provides a special virtual device to represent a resident of your home.
Based on the current state and other readings, you may trigger other actions within FHEM.
Used by superior module RESIDENTS but may also be used stand-alone.
Use comma separated list of resident device names for multi-membership (see example below).
Example:

`# Standalone
define rr_Manfred ROOMMATE
# Typical group member
define rr_Manfred ROOMMATE rgr_Residents # to be member of resident group rgr_Residents
# Member of multiple groups
define rr_Manfred ROOMMATE rgr_Residents,rgr_Parents # to be member of resident group rgr_Residents and rgr_Parents
# Complex family structure
define rr_Manfred ROOMMATE rgr_Residents,rgr_Parents # Parent
define rr_Lisa ROOMMATE rgr_Residents,rgr_Parents # Parent
define rr_Rick ROOMMATE rgr_Residents,rgr_Children # Child1
define rr_Alex ROOMMATE rgr_Residents,rgr_Children # Child2`

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

Set

`set <rr_FirstName> <command> [<parameter>]`
Currently, the following commands are defined.

- location - sets reading 'location'; see attribute rr_locations to adjust list shown in FHEMWEB
- mood - sets reading 'mood'; see attribute rr_moods to adjust list shown in FHEMWEB
- state home,gotosleep,asleep,awoken,absent,gone switch between states; see attribute rr_states to adjust list shown in FHEMWEB
- create
- locationMap add a pre-configured weblink device using showing a Google Map if readings locationLat+locationLong are present.
- wakeuptimer add several pre-configurations provided by RESIDENTS Toolkit. See separate section in RESIDENTS module commandref for details.

Note: If you would like to restrict access to admin set-commands (-> create) 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.

Possible states and their meaning

This module differs between 6 states:

- home - individual is present at home and awake
- gotosleep - individual is on it's way to bed
- asleep - individual is currently sleeping
- awoken - individual just woke up from sleep
- absent - individual is not present at home but will be back shortly
- gone - individual is away from home for longer period

Presence correlation to location

Under specific circumstances, changing state will automatically change reading 'location' as well.
Whenever presence state changes from 'absent' to 'present', the location is set to 'home'. If attribute rr_locationHome was defined, first location from it will be used as home location.
Whenever presence state changes from 'present' to 'absent', the location is set to 'underway'. If attribute rr_locationUnderway was defined, first location from it will be used as underway location.

Auto Gone

Whenever an individual is set to 'absent', a trigger is started to automatically change state to 'gone' after a specific timeframe.
Default value is 36 hours.
This behaviour can be customized by attribute rr_autoGoneAfter.

Synchronizing presence with other ROOMMATE or GUEST devices

If you always leave or arrive at your house together with other roommates or guests, you may enable a synchronization of your presence state for certain individuals.
By setting attribute rr_passPresenceTo, those individuals will follow your presence state changes to 'home', 'absent' or 'gone' as you do them with your own device.
Please note that individuals with current state 'gone' or 'none' (in case of guests) will not be touched.

Location correlation to state

Under specific circumstances, changing location will have an effect on the actual state as well.
Whenever location is set to 'home', the state is set to 'home' if prior presence state was 'absent'. If attribute rr_locationHome was defined, all of those locations will trigger state change to 'home' as well.
Whenever location is set to 'underway', the state is set to 'absent' if prior presence state was 'present'. If attribute rr_locationUnderway was defined, all of those locations will trigger state change to 'absent' as well. Those locations won't appear in reading 'lastLocation'.
Whenever location is set to 'wayhome', the reading 'wayhome' is set to '1' if current presence state is 'absent'. If attribute rr_locationWayhome was defined, LEAVING one of those locations will set reading 'wayhome' to '1' as well. So you actually have implicit and explicit options to trigger wayhome.
Arriving at home will reset the value of 'wayhome' to '0'.
If you are using the GEOFANCY module, you can easily have your location updated with GEOFANCY events by defining a simple NOTIFY-trigger like this:
`define n_rr_Manfred.location notify geofancy:currLoc_Manfred.* set rr_Manfred:FILTER=location!=$EVTPART1 location $EVTPART1`
By defining geofencing zones called 'home' and 'wayhome' in the iOS app, you automatically get all the features of automatic state changes described above.

Attributes

- rr_autoGoneAfter - hours after which state should be auto-set to 'gone' when current state is 'absent'; defaults to 36 hours
- rr_geofenceUUIDs - comma separated list of device UUIDs updating their location via GEOFANCY. Avoids necessity for additional notify/DOIF/watchdog devices and can make GEOFANCY attribute devAlias obsolete. (using more than one UUID/device might not be a good idea as location my leap)
- rr_locationHome - locations matching these will be treated as being at home; first entry reflects default value to be used with state correlation; separate entries by space; defaults to 'home'
- rr_locationUnderway - locations matching these will be treated as being underway; first entry reflects default value to be used with state correlation; separate entries by comma or space; defaults to "underway"
- rr_locationWayhome - leaving a location matching these will set reading wayhome to 1; separate entries by space; defaults to "wayhome"
- rr_locations - list of locations to be shown in FHEMWEB; separate entries by comma only and do NOT use spaces
- rr_moodDefault - the mood that should be set after arriving at home or changing state from awoken to home
- rr_moodSleepy - the mood that should be set if state was changed to gotosleep or awoken
- rr_moods - list of moods to be shown in FHEMWEB; separate entries by comma only and do NOT use spaces
- rr_noDuration - may be used to disable duration timer calculation (see readings durTimer*)
- rr_passPresenceTo - synchronize presence state with other ROOMMATE or GUEST devices; separte devices by space
- rr_presenceDevices - take over presence state from any other FHEM device. Separate more than one device with comma meaning ALL of them need to be either present or absent to trigger update of this ROOMMATE device.
- rr_realname - whenever ROOMMATE wants to use the realname it uses the value of attribute alias or group; defaults to group
- rr_showAllStates - states 'asleep' and 'awoken' are hidden by default to allow simple gotosleep process via devStateIcon; defaults to 0
- rr_states - list of states to be shown in FHEMWEB; separate entries by comma only and do NOT use spaces; unsupported states will lead to errors though
- rr_wakeupDevice - reference to enslaved DUMMY devices used as a wake-up timer (part of RESIDENTS Toolkit's wakeuptimer)

Generated Readings/Events:

- durTimerAbsence - timer to show the duration of absence from home in human readable format (hours:minutes:seconds)
- durTimerAbsence_cr - timer to show the duration of absence from home in computer readable format (minutes)
- durTimerPresence - timer to show the duration of presence at home in human readable format (hours:minutes:seconds)
- durTimerPresence_cr - timer to show the duration of presence at home in computer readable format (minutes)
- durTimerSleep - timer to show the duration of sleep in human readable format (hours:minutes:seconds)
- durTimerSleep_cr - timer to show the duration of sleep in computer readable format (minutes)
- lastArrival - timestamp of last arrival at home
- lastAwake - timestamp of last sleep cycle end
- lastDeparture - timestamp of last departure from home
- lastDurAbsence - duration of last absence from home in human readable format (hours:minutes:seconds)
- lastDurAbsence_cr - duration of last absence from home in computer readable format (minutes)
- lastDurPresence - duration of last presence at home in human readable format (hours:minutes:seconds)
- lastDurPresence_cr - duration of last presence at home in computer readable format (minutes)
- lastDurSleep - duration of last sleep in human readable format (hours:minutes:seconds)
- lastDurSleep_cr - duration of last sleep in computer readable format (minutes)
- lastLocation - the prior location
- lastMood - the prior mood
- lastSleep - timestamp of last sleep cycle begin
- lastState - the prior state
- lastWakeup - time of last wake-up timer run
- lastWakeupDev - device name of last wake-up timer
- location - the current location
- mood - the current mood
- nextWakeup - time of next wake-up program run
- nextWakeupDev - device name for next wake-up program run
- presence - reflects the home presence state, depending on value of reading 'state' (can be 'present' or 'absent')
- state - reflects the current state
- wakeup - becomes '1' while a wake-up program of this resident is being executed
- wayhome - depending on current location, it can become '1' if individual is on his/her way back home

### RPII2C

(en | de)

Provides access to Raspberry Pi's I2C interfaces for some logical modules and also directly.
This modul will basically work on every linux system that provides `/dev/i2c-x`.
preliminary:

- load I2C kernel modules (choose one of the following options):
  - open /etc/modules
    `sudo nano /etc/modules`
    add these lines
    `i2c-dev
    i2c-bcm2708
    `
  - Since Kernel 3.18.x on raspberry pi and maybe on other boards too, device tree support was implemented and enabled by default. To enable I2C support just add
    `device_tree_param=i2c0=on,i2c1=on`
    to /boot/config.txt You can also enable just one of the I2C. In this case remove the unwantet one from the line.
  - On Raspbian images since 2015 just start `sudo raspi-config` and enable I2C there. Parameters will be added automaticly to /boot/config.txt
  reboot
- Choose only one of the three follwing methodes do grant access to `/dev/i2c-*` for FHEM user:
  - `sudo apt-get install i2c-tools
    sudo adduser fhem i2c
    sudo reboot`
  - Add following lines into `/etc/init.d/fhem` before `perl fhem.pl` line in start or into `/etc/rc.local`:
    `sudo chown fhem /dev/i2c-*
    sudo chgrp dialout /dev/i2c-*
    sudo chmod +t /dev/i2c-*
    sudo chmod 660 /dev/i2c-*
    `
  - Alternatively for Raspberry Pi you can install the gpio utility from WiringPi library change access rights of I2C-Interface
    WiringPi installation is described here: RPI_GPIO.
    gpio utility will be automaticly used, if installed.
    Important: to use I2C-0 at P5 connector you must use attribute `swap_i2c0`.
- Optional: access via IOCTL will be used (RECOMMENDED) if Device::SMBus is not present.
  To access the I2C-Bus via the Device::SMBus module, following steps are necessary:
  `sudo apt-get install libmoose-perl
  sudo cpan Device::SMBus`
- For Raspbian users only
  If you are using I2C-0 at P5 connector on Raspberry Pi model B with newer raspbian versions, including support for Raspberry Pi model B+, you must add following line to `/boot/cmdline.txt`:
  `bcm2708.vc_i2c_override=1`

Define

`define <name> RPII2C <I2C Bus Number>`
where `<I2C Bus Number>` is the number of the I2C bus that should be used (0 or 1)

Set

- Write one byte (or more bytes sequentially) directly to an I2C device (for devices that have only one register to write):
  `set <name> writeByte <I2C Address> <value>`
- Write n-bytes to an register range (as an series of single register write operations), beginning at the specified register:
  `set <name> writeByteReg <I2C Address> <Register Address> <value> [<value> [..]]`
- Write n-bytes directly to an I2C device (as an block write operation):
  `set <name> writeBlock <I2C Address> <Register Address> <value> [<value> [..]]`
- Write n-bytes to an register range (as an block write operation), beginning at the specified register:
  `set <name> writeBlockReg <I2C Address> <Register Address> <value> [<value> [..]]`
Examples:

Write 0xAA to device with I2C address 0x60
`set test1 writeByte 60 AA`
Write 0xAA to register 0x01 of device with I2C address 0x6E
`set test1 writeByteReg 6E 01 AA`
Write 0xAA to register 0x01 of device with I2C address 0x6E, after it write 0x55 to 0x02 as two separate commands
`set test1 writeByteReg 6E 01 AA 55`
Write 0xA4 to register 0x03, 0x00 to register 0x04 and 0xDA to register 0x05 of device with I2C address 0x60 as an block command
`set test1 writeBlock 60 03 A4 00 DA`

Get

- Gets value of I2C device's registers:
  `get <name> read <I2C Address> [<Register Address> [<number of registers>]]`
- Gets value of I2C device in blockwise mode:
  `get <name> readblock <I2C Address> [<number of registers>]`
- Gets value of I2C device's registers in blockwise mode:
  `get <name> readblockreg <I2C Address> <Register Address> [<number of registers>]`
Examples:

Reads byte from device with I2C address 0x60
`get test1 read 60`
Reads register 0x01 of device with I2C address 0x6E.
`get test1 read 6E 01 AA 55`
Reads register 0x03 to 0x06 of device with I2C address 0x60.
`get test1 read 60 03 4`

Attributes

- swap_i2c0
  Swap Raspberry Pi's I2C-0 from J5 to P5 rev. B
  This attribute is for Raspberry Pi only and needs gpio utility from WiringPi library.
  Default: none, valid values: on, off
- useHWLib
  Change hardware access method.
  Attribute exists only if both access methods are usable
  Default: IOCTL, valid values: IOCTL, SMBus
- ignore
- do_not_notify
- showtime

### RPI_GPIO

(en | de)

Raspberry Pi offers direct access to several GPIO via header P1 (and P5 on V2). The Pinout is shown in table under define. With this module you are able to access these GPIO's directly as output or input. For input you can use either polling or interrupt mode
In addition to the Raspberry Pi, also BBB, Cubie, Banana Pi and almost every linux system which provides gpio access in userspace is supported.
Warning: Never apply any external voltage to an output configured pin! GPIO's internal logic operate with 3,3V. Don't exceed this Voltage!
preliminary:
GPIO Pins accessed by sysfs. The files are located in folder `/system/class/gpio` and belong to the gpio group (on actual Raspbian distributions since jan 2014). It will work even on an Jessie version but NOT if you perform an kerlen update
After execution of following commands, GPIO's are usable whithin PRI_GPIO:

`sudo adduser fhem gpio
sudo reboot`

If attribute `pud_resistor` shall be used and on older Raspbian distributions, aditionally gpio utility from WiringPi library must be installed to set the internal pullup/down resistor or export and change access rights of GPIO's (for the second case active_low does not work).
Installation WiringPi:

`sudo apt-get update
sudo apt-get upgrade
sudo apt-get install git-core
git clone git://git.drogon.net/wiringPi
cd wiringPi ./build`

On Linux systeme where `/system/class/gpio` can only accessed as root, GPIO's must exported and their access rights changed before FHEM starts.
This can be done in `/etc/rc.local` (Examole for GPIO22 and 23):

`echo 22 > /sys/class/gpio/export
echo 23 > /sys/class/gpio/export
chown -R fhem:root /sys/devices/virtual/gpio/* (or chown -R fhem:gpio /sys/devices/platform/gpio-sunxi/gpio/* for Banana Pi)
chown -R fhem:root /sys/class/gpio/*
`

Define

`define <name> RPI_GPIO <GPIO number>[ <GPIO-Basedir>[ <WiringPi-gpio-utility>]]`
all usable `GPIO number` can be found here
Examples:

          define Pin12 RPI_GPIO 18
          attr Pin12 poll_interval 5
    	  define Pin12 RPI_GPIO 18 /sys/class/gpio /usr/somewhere/bin/gpio

Set

`set <name> <value>`
where `value` is one of:

- for output configured GPIO
  `off
  on
  toggle
  `
  The set extensions are also supported.
- for input configured GPIO
  `readval`
  readval refreshes the reading Pinlevel and, if attr toggletostate not set, the state value

Examples:

`set Pin12 off`
`set Pin11,Pin12 on`

Get

`get <name>`
returns "high" or "low" regarding the actual status of the pin and writes this value to reading Pinlevel

Attributes

- direction
  Sets the GPIO direction to input or output.
  Default: input, valid values: input, output
- active_low
  Inverts logical value
  Default: off, valid values: on, off
- interrupt
  can only be used with GPIO configured as input
  enables edge detection for GPIO pin
  on each interrupt event readings Pinlevel and state will be updated
  Default: none, valid values: none, falling, rising, both
  For "both" the reading Longpress will be added and set to on as long as kes hold down longer than 1s
  For "falling" and "rising" the reading Toggle will be added an will be toggled at every interrupt and the reading Counter that increments at every interrupt
- poll_interval
  Set the polling interval in minutes to query the GPIO's level
  Default: -, valid values: decimal number
- toggletostate
  works with interrupt set to falling or rising only
  if yes, state will be toggled at each interrupt event
  Default: no, valid values: yes, no
- pud_resistor
  Sets the internal pullup/pulldown resistor
  Works only with installed gpio urility from WiringPi Library.
  Default: -, valid values: off, up, down
- debounce_in_ms
  readout of pin value x ms after an interrupt occured. Can be used for switch debouncing
  Default: 0, valid values: decimal number
- restoreOnStartup
  Restore Readings and sets after reboot
  Default: last, valid values: last, on, off, no
- unexportpin
  do an unexport to /sys/class/gpio/unexport if the pin definition gets cleared (e.g. by rereadcmd, delete,...)
  Default: yes, valid values: yes, no
- longpressinterval
  works with interrupt set to both only
  time in seconds, a port need to be high to set reading longpress to on
  Default: 1, valid values: 0.1 - 10
- readingFnAttributes

### RSS

Provides a freely configurable RSS feed and HTML page.

The media RSS feed delivers status pictures either in JPEG or PNG format. This media RSS feed can be used to feed a status display to a network-enabled photo frame.

In addition, a periodically refreshing HTML page is generated that shows the picture with an optional HTML image map.

You need to have the perl module `GD` installed. This module is most likely not available for small systems like Fritz!Box.

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

Beginners might find the RSS Workshop useful.

A note on colors: Colors are specified as 6- or 8-digit hex numbers, every 2 digits determining the red, green and blue color components as in HTML color codes. The optional 7th and 8th digit code the alpha channel (transparency from 00 to 7F). Examples: `FF0000` for red, `C0C0C0` for light gray, `1C1C1C40` for semi-transparent gray.

Define

`define <name> RSS jpg|png <hostname> <filename>`
Defines the RSS feed. `jpg` and `png` are fixed literals to select output format. `<hostname>` is the hostname of the fhem server as seen from the consumer of the RSS feed. `<filename>` is the name of the file that contains the layout definition.

Examples

`define FrameRSS RSS jpg host.example.org /etc/fhem/layout`
`define MyRSS RSS png 192.168.1.222 /var/fhem/conf/layout.txt`

The RSS feeds are at

`http://host.example.org:8083/fhem/rss/FrameRSS.rss`
`http://192.168.1.222:8083/fhem/rss/MyRSS.rss`

The pictures are at

`http://host.example.org:8083/fhem/rss/FrameRSS.jpg`
`http://192.168.1.222:8083/fhem/rss/MyRSS.png`

The HTML pages are at

`http://host.example.org:8083/fhem/rss/FrameRSS.html`
`http://192.168.1.222:8083/fhem/rss/MyRSS.html`

Set

`set <name> rereadcfg`
Rereads the layout definition from the file. Useful to enable changes in the layout on-the-fly.

Attributes

- autoreread
  If set to 1, layout is automatically reread when layout file has been changed by FHEMWEB file editor.
- size
  The dimensions of the picture in the format `<width>x<height>`.
- bg
  The directory that contains the background pictures (must be in JPEG, GIF or PNG format, file format is guessed from file name extension).
- bgcolor <color>
  Sets the background color.
- tmin
  The background picture is shown at least `tmin` seconds, no matter how frequently the RSS feed consumer accesses the page.
- refresh <interval>
  Time in seconds after which the HTML page is automatically reloaded. Defaults to 60. Set <interval> to 0 to disable reloading.
- viewport
  Adds a viewport directive to the HTML header.
  Example: `attr FrameRSS viewport width=device-width, initial-scale=1.0, minimum-scale=1.0, maximum-scale=1.0`
  This scales the image to fit to the browser's viewport and inhibits zooming in or out on tablets.
- noscrollSuppresses scrollbars in browsers, if set to 1.
- areas
  HTML code that goes into the image map.
  Example: `attr FrameRSS areas <area shape="rect" coords="0,0,200,200" href="http://fhem.de"/><area shape="rect" coords="600,400,799,599" href="http://has:8083/fhem" target="_top"/>`
- itemtitleAdds a title tag to the RSS item that contains the specified text.
- urlOverride
  Overrides the URL in the generated feed. If you specify `attr <name> http://otherhost.example.org:8083/foo/bar`, the JPEG picture that is at `http://host.example.org:8083/fhem/rss/FrameRSS.jpg` will be referenced as `http://otherhost.example.org:8083/foo/bar/rss/FrameRSS.jpg`. This is useful when your FHEM URLs are rewritten, e.g. if FHEM is accessed by a Reverse Proxy.

Usage information

If a least one RSS feed is defined, the menu entry `RSS` appears in the FHEMWEB side menu. If you click it you get a list of all defined RSS feeds. The URL of any such is RSS feed is `http://hostname:port/fhem/rss/name.rss` with `hostname` and `name` from the RSS feed's definition and the `port` (usually 8083) and literal `/fhem` from the underlying FHEMWEB definition.

Example:

`http://host.example.org:8083/fhem/rss/FrameRSS.rss`

The media RSS feed points to a dynamically generated picture. The URL of the picture belonging to the RSS can be found by replacing the extension ".rss" in feed's URL by ".jpg" or ".png" depending on defined output format,

Example:

`http://host.example.org:8083/fhem/rss/FrameRSS.jpg`

`http://192.168.100.200:8083/fhem/rss/FrameRSS.png`

To render the picture the current, or, if `tmin` seconds have elapsed, the next JPEG picture from the directory `bg` is chosen and scaled to the dimensions given in `size`. The background is black if no usable JPEG picture can be found. Next the script in the layout definition is used to superimpose items on the background.

You can directly access the URL of the picture in your browser. Reload the page to see how it works.

The media RSS feed advertises to refresh after 1 minute (ttl). Some photo frames ignore it and use their preset refresh rate. Go for a photo frame with an adjustable refresh rate (e.g every 5 seconds) if you have the choice!

This is how the fhem config part might look like:

`define ui FHEMWEB 8083 global
define FrameRSS RSS jpg host.example.org /etc/fhem/layout
attr FrameRSS size 800x600
attr FrameRSS bg /usr/share/pictures
attr FrameRSS tmin 10
`

Layout definition

The layout definition is a script for placing items on the background. It is read top-down. It consists of layout control commands and items placement commands. Layout control commands define the appearance of subsequent items. Item placement commands actually render items.

Everything after a # is treated as a comment and ignored. You can fold long lines by putting a \ at the end.

General notes

1. Use double quotes to quote literal text if perl specials are allowed.
2. Text alignment requires the Perl module GD::Text::Align to be installed. Text wrapping (in text boxes) require GD::Text::Wrap to be installed. Debian-based systems can install both with `apt-get install libgd-text-perl`.

Notes on coordinates

1. (0,0) is the upper left corner.
2. Coordinates equal or greater than 1 are considered to be absolute pixels, coordinates between 0 and 1 are considered to be relative to the total width or height of the picture.
3. Literal `x` and `y` evaluate to the most recently used x- and y-coordinate. See also moveto and moveby below.

Layout control commands

- moveto <x> <y>
  Moves most recently used x- and y-coordinate to the given absolute or relative position.
- moveby <x> <y>
  Moves most recently used x- and y-coordinate by the given absolute or relative amounts.
- font "<font>"
  Sets the font. <font> is the name of a TrueType font (e.g. `Arial`) or the full path to a TrueType font (e.g. `/usr/share/fonts/truetype/arial.ttf`), whatever works on your system.
- rgb "<color>"
  Sets the color. You can use `{ <perl special> }` for <color>.
- pt <pt>
  Sets the font size in points. A + or - sign in front of the the number given for <pt> signifies a change of the font size relative to the current size. Otherwise the absolute size is set. You can use `{ <perl special> }` for <pt>.
- thalign|ihalign|halign "left"|"center"|"right"
  Sets the horizontal alignment of text, image or both. Defaults to left-aligned. You can use `{ <perl special> }` instead of the literal alignment control word.
- tvalign|ivalign|valign "top"|"center"|"base"|"bottom"
  Sets the vertical alignment of text, image or both. Defaults to base-aligned for text and top-aligned for image. You can use `{ <perl special> }` instead of the literal alignment control word.
- linespace <space>
  Sets the line spacing in pixels for text boxes (see textbox item below).
- condition <condition>
  Subsequent layout control and item placement commands except for another condition command are ignored if and only if <condition> evaluates to false.
- push
  The current parameter set (position, color, font name and size, text alignment and line spacing) is put (saved) on top of a stack.
- pop
  The most recently saved (pushed) current parameter set is pulled from the top of the stack and restored.

Item placement commands

- text <x> <y> <text>
  Renders the text <text> at the position (<x>, <y>) using the current font, font size and color. You can use `{ <perl special> }` for <text> to fully access device readings and do some programming on the fly. See below for examples.
- textbox <x> <y> <boxwidth> <text>
  Same as before but text is rendered in a box of horizontal width <boxwidth>.
- textboxf <x> <y> <boxwidth> <bgcolor> <text>
  Same as before but the textbox will be filled with the given background color <bgcolor> before drawing the text. <bgcolor> can be used with `{ <perl special> }` to evalute RGB value.
- time <x> <y>
  Renders the current time in HH:MM format.
- seconds <x> <y> <format>
  Renders the curent seconds. Maybe useful for a RSS Clock.
- date <x> <y>
  Renders the current date in DD.MM.YYYY format.
- line <x1> <y1> <x2> <y2> [<thickness>]
  Draws a line from position (<x1>, <y1>) to position (<x2>, <y2>) with optional thickness (default=1).
- rect <x1> <y1> <x2> <y2> [<filled>]
  Draws a rectangle with corners at positions (<x1>, <y1>) and (<x2>, <y2>), which is filled if the <filled> parameter is set and not zero.
- img <x> <y> <['w' or 'h']s> <imgtype> <srctype> <arg>
  Renders a picture at the position (<x>, <y>). The <imgtype> is one of `gif`, `jpeg`, `png`. The picture is scaled by the factor <s> (a decimal value). If 'w' or 'h' is in front of scale-value the value is used to set width or height to the value in pixel. If <srctype> is `file`, the picture is loaded from the filename <arg>, if <srctype> is `url` or `urlq`, the picture is loaded from the URL <arg> (with or without logging the URL), if <srctype> is `data`, the picture is piped in from data <arg>. You can use `{ <perl special> }` for <arg>. See below for example.
  Warning: do not load the image from URL that is served by fhem as it leads to a deadlock.
- embed <x> <y> <z> <position> <id> <element>
  For HTML output: embeds a `div` element into the HTML page at (<x>,<y>) with z-order <z> and positioning <position> (use `absolute`). <id> is the `id` attribute of the `div` element and <element> is its content.
  Note: There are several issues with different browsers when using this.

Example

This is how a layout definition might look like:

`font /usr/share/fonts/truetype/arial.ttf # must be a TrueType font
rgb "c0c0c0" # HTML color notation, RGB
pt 48 # font size in points
time 0.10 0.90
pt 24
text 0.10 0.95 { ReadingsVal("MyWeather","temperature","?"). "C" }
moveby 0 -25
text x y "Another text"
img 20 530 0.5 png file { "/usr/share/fhem/www/images/weather/" . ReadingsVal("MyWeather","icon","") . ".png" }
embed 0 0 2 absolute plot1 { plotFromUrl('mySVG') } embed 10 200 2 absolute iframe1 "<iframe width=\"420\" height=\"315\" src=\"//www.youtube.com/embed/9HShl_ufOFI\" frameborder=\"0\" allowfullscreen></iframe>"`

Special uses

You can display SVG plots with the aid of the helper function `plotAsPng(<name>[,<zoom>[,<offset>]])` (in 98_SVG.pm). Examples:

`img 20 30 0.6 png data { plotAsPng("mySVGPlot") }
img 20 30 0.6 png data { plotAsPng("mySVGPlot","qday",-1) }`

This requires the perl module Image::LibRSVG and librsvg. Debian-based systems can install these with `apt-get install libimage-librsvg-perl`.

For HTML output, you can use `plotFromURL(<name>[,<zoom>[,<offset>]])` instead.

# RandomTimer

## Define

`define <name> RandomTimer <timespec_start> <device> <timespec_stop> [<timeToSwitch>]`
Defines a device, that imitates the random switch functionality of a timer clock, like a FS20 ZSU. The idea to create it, came from the problem, that is was always a little bit tricky to install a timer clock before holiday: finding the manual, testing it the days before and three different timer clocks with three different manuals - a horror.
By using it in conjunction with a dummy and a disableCond, I'm able to switch the always defined timer on every weekend easily from all over the world.

### Descrition

a RandomTimer device starts at timespec_start switching device. Every (timeToSwitch seconds +-10%) it trys to switch device on/off. The switching period stops when the next time to switch is greater than timespec_stop.

### Parameter

timespec_start
The parameter timespec_start defines the start time of the timer with format: HH:MM:SS. It can be a Perlfunction as known from the at timespec .
device
The parameter device defines the fhem device that should be switched.
timespec_stop
The parameter timespec_stop defines the stop time of the timer with format: HH:MM:SS. It can be a Perlfunction as known from the timespec at .
timeToSwitch
The parameter timeToSwitch defines the time in seconds between two on/off switches.

### Examples

- `define ZufallsTimerTisch RandomTimer *{sunset_abs()} StehlampeTisch +03:00:00 500`
  defines a timer that starts at sunset an ends 3 hous later. The timer trys to switch every 500 seconds(+-10%).
- `define ZufallsTimerTisch RandomTimer *{sunset_abs()} StehlampeTisch *{sunset_abs(3*3600)} 480`
  defines a timer that starts at sunset and stops after sunset + 3 hours. The timer trys to switch every 480 seconds(+-10%).
- `define ZufallsTimerTisch RandomTimer *{sunset_abs()} StehlampeTisch 22:30:00 300`
  defines a timer that starts at sunset an ends at 22:30. The timer trys to switch every 300 seconds(+-10%).

### Set

N/A

### Get

N/A

### Attributes

- readingFnAttributes
- disableCond
  The default behavior of a RandomTimer is, that it works. To set the Randomtimer out of work, you can specify in the disableCond attibute a condition in perlcode that must evaluate to true. The Condition must be put into round brackets. The best way is to define a function in 99_utils.
  Examples

              attr   ZufallsTimerZ         disableCond      (!isVerreist())
              attr   ZufallsTimerZ         disableCond      (Value("presenceDummy") ne "present")

- keepDeviceAlive
  The default behavior of a RandomTimer is, that it shuts down the device after stoptime is reached. The keepDeviceAlive attribute changes the behavior. If set, the device status is not changed when the stoptime is reached.
  Example

              attr   ZufallsTimerZ         keepDeviceAlive

- onCmd, offCmd
  Setting the on-/offCmd changes the command sent to the device. Standard is: "set <device> on". The device can be specified by a @.
  Examples

              attr   Timer                  oncmd   {fhem("set @ on-for-timer 14")}
              attr   Timer                  offCmd  {fhem("set @ off 16")}
              attr   Timer                  oncmd  set @ on-for-timer 12
              attr   Timer                  offCmd set @ off 12

- switchmode
  Setting the switchmode you can influence the behavior of switching on/off. The parameter has the Format 999/999 and the default ist 800/200. The values are in "per mill". The first parameter sets the value of the probability that the device will be switched on when the device is off. The second parameter sets the value of the probability that the device will be switched off when the device is off. Examples

              attr   ZufallsTimerZ         switchmode  400/400

### Revolt NC-5462

Provides voltage, current, frequency, power, pf, energy readings for Revolt NC-5462 devices via CUL.
Define

`define <name> Revolt <id>`
<id> is a 4 digit hex number to identify the NC-5462 device.
Note: devices are autocreated on reception of the first message.

Readings

- energy [kWh]
- power [W]
- voltage [V]
- current [A]
- frequency [Hz]
- Pf

### Robonect

Robonect is a after-market wifi-module for robomowers based on the husky G3-control. It was developed by Fabian H. and can be optained at www.robonect.de. This module gives you access to the basic commands. This module will not work without libjson-perl! Do not forget to install it first!

Define

`define <name> Robonect <ip-adress> [<user> <password>]`

Setting Winterschlaf prevents communicating with the mower.

The authentication can be supplied in the definition as plaine text or in a differen way - see the attributes. Per default the status is polled every 90s.

Example:

          define myMower Robonect 192.168.13.5 test tmySecret

Set

Switch the mower to automatic-timer: `set <name> auto` Send the mower home - prevents further runs triggered by timer (persistent): `set <name> home` Sends the mower home for the actual timer-slot. The next timer-slot starts the mower again: `set <name> feierabend` Start the mower (only needed after a manual stop: `set <name> start` Stop the mower immediately: `set <name> stop`

Get

Gets the actual state of the mower - normally not needed, because the status is polled cyclic.

Attributes

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

credentials

If you supply a valid path to a credentials file, this combination is used to log in at robonect. This mechism overrules basicAuth.

basicAuth

You can supply username and password plain or base-64-encoded. For a base64-encoder, use google.

Example:

          define myMower 192.168.5.1
    	  attr myMower basicAuth me:mySecret

          define myMower 192.168.5.1
    	  attr myMower basicAuth bWU6bXlTZWNyZXQ=

pollInterval

Supplies the interval top poll the robonect in seconds. Per default 90s is set.

timeout

Timeout for httpData to recive data. Default is 4s.

### S7

This module connects a SIEMENS PLC (Note: also SIEMENS Logo is supported). The TCP communication module is based on settimino (http://settimino.sourceforge.net) You can found a german wiki here: httl://www.fhemwiki.de/wiki/S7
For the communication the following modules have been implemented:

- S7 … sets up the communication channel to the PLC
- S7_ARead … Is used for reading integer Values from the PLC
- S7_AWrite … Is used for write integer Values to the PLC
- S7_DRead … Is used for read bits
- S7_DWrite … Is used for writing bits.

Reading work flow:
The S7 module reads periodically the configured DB areas from the PLC and stores the data in an internal buffer. Then all reading client modules are informed. Each client module extracts his data and the corresponding readings are set. <brl> <brl> Writing work flow:
At the S7 module you need to configure the PLC writing target. Also the S7 module holds a writing buffer. Which contains a master copy of the data needs to send.
(Note: after configuration of the writing area a copy from the PLC is read and used as initial fill-up of the writing buffer)
Note: The S7 module will send always the whole data block to the PLC. When data on the clients modules is set then the client module updates the internal writing buffer on the S7 module and triggers the writing to the PLC.
Define

`define <name> S7 <PLC_address> <rack> <slot> [<Interval>]`
`define logo S7 10.0.0.241 2 0`

- PLC_address … IP address of the S7 PLC (For S5 see below)
- rack … rack of the PLC
- slot … slot of the PLC
- Interval … Intervall how often the modul should check if a reading is required

Note: For Siemens logo you should use a alternative (more simply configuration method):
define logo S7 LOGO7 10.0.0.241

Note: For Siemens S5 you must use a alternative (more simply configuration method):
define logo S7 S5 /dev/tty1 in this case the PLC_address is the serial port number
Attr
The following attributes are supported:

- MaxMessageLength
MaxMessageLength ... restricts the packet length if lower than the negioated PDULength. This could be used to increate the processing speed. 2 small packages may be smaler than one large package

### S7_ARead

This module is a logical module of the physical module S7.
This module provides analog data (signed / unsigned integer Values).
Note: you have to configure a PLC reading at the physical module (S7) first.
Define
`define <name> S7_ARead {inputs|outputs|flags|db} <DB> <start> {u8|s8|u16|s16|u32|s32}`

- inputs|outputs|flags|db … defines where to read.
- DB … Number of the DB
- start … start byte of the reading
- {u8|s8|u16|s16|u32|s32} … defines the datatype:

- u8 …. unsigned 8 Bit integer
- s8 …. signed 8 Bit integer
- u16 …. unsigned 16 Bit integer
- s16 …. signed 16 Bit integer
- u32 …. unsigned 32 Bit integer
- s32 …. signed 32 Bit integer

Note: the required memory area (start – start + datatypelength) need to be with in the configured PLC reading of the physical module.

Attr
The following parameters are used to scale every reading

- multiplicator
- offset

newValue = <multiplicator> * Value + <offset>

### S7_AWrite

This module is a logical module of the physical module S7.

This module provides sending analog data (unsigned integer Values) to the PLC.

Note: you have to configure a PLC writing at the physical modul (S7) first.

Define
`define <name> S7_AWrite {inputs|outputs|flags|db} <DB> <start> {u8|s8|u16|s16|u32|s32|float}`

- db … defines where to read. Note currently only writing in to DB are supported.
- DB … Number of the DB
- start … start byte of the reading
- {u8|s8|u16|s16|u32|s32} … defines the datatype:

- u8 …. unsigned 8 Bit integer
- s8 …. signed 8 Bit integer
- u16 …. unsigned 16 Bit integer
- s16 …. signed 16 Bit integer
- u32 …. unsigned 32 Bit integer
- s32 …. signed 32 Bit integer
- float …. 4 byte float

Note: the required memory area (start – start + datatypelength) need to be with in the configured PLC writing of the physical module.

Set
`set <name> S7_AWrite <value>`

- value … an numeric value

### S7_Client

abstract interface layer S7 / S5

### S7_DRead

This module is a logical module of the physical module S7.
This module provides digital data (ON/OFF).
Note: you have to configure a PLC reading at the physical modul (S7) first.
Define

`define <name> S7_DRead {inputs|outputs|flags|db} <DB> <address>`

- inputs|outputs|flags|db … defines where to read.
- DB … Number of the DB
- address … address you want to read. bit number to read. Example: 10.3

Note: the required memory area need to be with in the configured PLC reading of the physical module.

### S7_DWrite

This module is a logical module of the physical module S7.

This module is used to set/unset a Bit in ad DB of the PLC.

Note: you have to configure a PLC writing at the physical modul (S7) first.

Define `define <name> S7_DWrite {db} <DB> <address>`

- db … defines where to read. Note currently only writing in to DB are supported.
- DB … Number of the DB
- address … address you want to write. bit number to read. Example: 10.6

Note: the required memory area need to be with in the configured PLC reading of the physical module.

Set `set <name> S7_AWrite {ON|OFF|TRIGGER};`

Note: TRIGGER sets the bit for 1s to ON than it will set to OFF.

Attr
The following parameters are used to scale every reading

- trigger_length ... sets the on-time of a trigger

### S7_S5Client

low level interface to S5

### S7_S7Client

low level interface to S7

### SCIVT

Define

`define <name> SCIVT <SCD-device>`
Define a SCD series solar controler device. Details see here. You probably need a Serial to USB controller like the PL2303.
Defining an SCIVT device 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, only a single get function which reads the device status immediately.
Example:

`define scd SCIVT /dev/ttyUSB2`

Set

N/A

Get

`get SCVIT data`

Attributes

- model (SCD)

### Weather Sensors various protocols

The SD_WS module interprets temperature sensor messages received by a Device like CUL, CUN, SIGNALduino etc.
Known models:

- Bresser 7009994
- Opus XT300

New received device are add in fhem with autocreate.
Define

The received devices created automatically.
The ID of the defice is the cannel or, if the longid attribute is specified, it is a combination of channel and some random generated bits at powering the sensor and the channel.
If you want to use more sensors, than channels available, you can use the longid option to differentiate them.

Generated readings:
Some devices may not support all readings, so they will not be presented

- State (T: H:)
- temperature (°C)
- humidity: (The humidity (1-100 if available)
- battery: (low or ok)
- channel: (The Channelnumber (number if)

Attributes

- do_not_notify
- ignore
- showtime
- readingFnAttributes

Set

N/A

Set

N/A

### Wether Sensors protocol #7

The SD_WS07 module interprets temperature sensor messages received by a Device like CUL, CUN, SIGNALduino etc.
Known models:

- Eurochon EAS800z
- Technoline WS6750/TX70DTH

New received device are add in fhem with autocreate.
Define

The received devices created automatically.
The ID of the defice is the cannel or, if the longid attribute is specified, it is a combination of channel and some random generated bits at powering the sensor and the channel.
If you want to use more sensors, than channels available, you can use the longid option to differentiate them.

Generated readings:
Some devices may not support all readings, so they will not be presented

- State (T: H:)
- temperature (°C)
- humidity: (The humidity (1-100 if available)
- battery: (low or ok)
- channel: (The Channelnumber (number if)

Attributes

- do_not_notify
- ignore
- model ()
- showtime
- readingFnAttributes

Set

N/A

Set

N/A

### Wether Sensors protocol #9

The SD_WS09 module interprets temperature sensor messages received by a Device like CUL, CUN, SIGNALduino etc.
Requires Perl-Modul Digest::CRC.
cpan install Digest::CRC or sudo apt-get install libdigest-crc-perl
Known models:

- WS-0101 --> Model: WH1080
- TFA 30.3189 / WH1080 --> Model: WH1080
- 1073 (WS1080) --> Model: WH1080
- CTW600 --> Model: CTW600 (??)

New received device are add in fhem with autocreate.
Define

The received devices created automatically.
The ID of the defice is the model or, if the longid attribute is specified, it is a combination of model and some random generated bits at powering the sensor.
If you want to use more sensors, you can use the longid option to differentiate them.

Generated readings:
Some devices may not support all readings, so they will not be presented

- State (T: H: Ws: Wg: Wd: R: ) temperature, humidity, windSpeed, windGuest, windDirection, Rain
- Temperature (°C)
- Humidity: (The humidity (1-100 if available)
- Battery: (low or ok)
- ID: (The ID-Number (number if)
- windSpeed (m/s) and windDirection (N-O-S-W)
- Rain (mm)

Attributes

- do_not_notify
- ignore
- showtime
- readingFnAttributes
- Model
  WH1080, CTW600
- windKorrektur
  -3,-2,-1,0,1,2,3

Set

N/A

Set

N/A

### Wether Sensors protocol #7

The SD_WS_Maverick module interprets temperature sensor messages received by a Device like CUL, CUN, SIGNALduino etc.
Known models:

- Eurochon EAS800z
- Technoline WS6750/TX70DTH

New received device are add in fhem with autocreate.
Define

The received devices created automatically.
The ID of the defice is the cannel or, if the longid attribute is specified, it is a combination of channel and some random generated bits at powering the sensor and the channel.
If you want to use more sensors, than channels available, you can use the longid option to differentiate them.

Generated readings:
Some devices may not support all readings, so they will not be presented

- State (T: H:)
- temperature (°C)
- humidity: (The humidity (1-100 if available)
- battery: (low or ok)
- channel: (The Channelnumber (number if)

Attributes

- do_not_notify
- ignore
- model ()
- showtime
- readingFnAttributes

Set

N/A

Set

N/A

### SHC

SHC is the basestation module that supports a family of RF devices available at www.smarthomatic.org. This module provides the IODevice for the SHCdev modules that implement the SHCdev protocol.
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> SHC <device>`
<device> specifies the serial port to communicate with the SHC. The name of the serial-device depends on your distribution, under linux usually a /dev/ttyUSB0 device will be created.
You can also specify a baudrate if the device name contains the @ character, e.g.: /dev/ttyUSB0@57600. Please note that the default baudrate for the SHC base station is 19200 baud.
Example:

`define shc_base SHC /dev/ttyUSB0`

Set

- raw <data>
  not supported yet

Get

- N/A

Attributes

- N/A

### SHCdev

SHC is the device module that supports several device types available at www.smarthomatic.org.
These device are connected to the FHEM server through the SHC base station (SHC).
Currently supported are:

- EnvSensor
- PowerSwitch
- Dimmer
- RGBDimmer
- SoilMoistureMeter

Define

`define <name> SHCdev <SenderID> [<AesKey>]`
<SenderID>
is a number ranging from 0 .. 4095 to identify the SHCdev device.
<AesKey>
is a optional number ranging from 0 .. 15 to select an encryption key. It is required for the basestation to communicate with remote devides The default value is 0.
Note: devices are autocreated on reception of the first message.

Set

- on
  Supported by Dimmer and PowerSwitch (on always refers to pin1).
- off
  Supported by Dimmer and PowerSwitch (off always refers to pin1).
- pct <0..100>
  Sets the brightness in percent. Supported by Dimmer.
- ani <AnimationMode> <TimeoutSec> <StartBrightness> <EndBrightness>
  Description and details available at www.smarthomatic.org Supported by Dimmer.
- statusRequest
  Supported by Dimmer and PowerSwitch.
- Color <ColorNumber>
  A detailed description is available at www.smarthomatic.org The color palette can be found here Supported by RGBDimmer.
- ColorAnimation <Repeat> <AutoReverse> <Time0> <ColorNumber0> <Time1> <ColorNumber1> ... up to 10 time/color pairs
  A detailed description is available at www.smarthomatic.org The color palette can be found here Supported by RGBDimmer.
- DigitalPin <Pos> <On>
  A detailed description is available at www.smarthomatic.org Supported by PowerSwitch.
- DigitalPinTimeout <Pos> <On> <Timeout>
  A detailed description is available at www.smarthomatic.org Supported by PowerSwitch.
- DigitalPort <On>
  <On>
  is a bit array (0 or 1) describing the port state. If less than eight bits were provided zero is assumed. Example: set SHC_device DigitalPort 10110000 will set pin0, pin2 and pin3 to 1.
  A detailed description is available at www.smarthomatic.org Supported by PowerSwitch.
- DigitalPortTimeout <On> <Timeout0> .. <Timeout7>
  <On>
  is a bit array (0 or 1) describing the port state. If less than eight bits were provided zero is assumed. Example: set SHC_device DigitalPort 10110000 will set pin0, pin2 and pin3 to 1.
  <Timeout0> .. <Timeout7>
  are the timeouts for each pin. If no timeout is provided zero is assumed. A detailed description is available at www.smarthomatic.org Supported by PowerSwitch.
- set extensions
  Supported by Dimmer and PowerSwitch.

Get

- din <pin>
  Returns the state of the specified digital input pin for pin = 1..8. Or the state of all pins for pin = all. Supported by EnvSensor.
- ain <pin>
  Returns the state of the specified analog input pin for pin = 1..5. Or the state of all pins for pin = all. If the voltage of the pin is over the specied trigger threshold) it return 1 otherwise 0. Supported by EnvSensor.
- ain <pin>
  Returns the state of the specified analog input pin for pin = 1..5. Or the state of all pins for pin = all. If the voltage of the pin is over the specied trigger threshold) it return 1 otherwise 0. Supported by EnvSensor.
- ain_volt <pin>
  Returns the voltage of the specified analog input pin for pin = 1..5 in millivolts, ranging from 0 .. 1100 mV. Supported by EnvSensor.

Attributes

- devtype
  The device type determines the command set, default web commands and the default devStateicon. Currently supported are: EnvSensor, Dimmer, PowerSwitch, RGBDimmer, SoilMoistureMeter.
  Note: If the device is not set manually, it will be determined automatically on reception of a device type specific message. For example: If a temperature message is received, the device type will be set to EnvSensor.
- readonly
  if set to a value != 0 all switching commands (on, off, toggle, ...) will be disabled.
- forceOn
  try to switch on the device whenever an off status is received.

### SIGNALduino

The SIGNALduino ia based on an idea from mdorenka published at FHEM Forum. With the opensource firmware (see this link) it is capable to receive and send different protocols over different medias. Currently are 433Mhz protocols implemented.
The following device support is currently available:
Wireless switches
ITv1 & ITv3/Elro and other brands using pt2263 or arctech protocol--> uses IT.pm
Temperatur / humidity senso

- PEARL NC7159, LogiLink WS0002,GT-WT-02,AURIOL,TCM97001, TCM27 and many more -> 14_CUL_TCM97001
- Oregon Scientific v2 and v3 Sensors -> 41_OREGON.pm
- Temperatur / humidity sensors suppored -> 14_SD_WS07
- technoline WS 6750 and TX70DTH -> 14_SD_WS07
- Eurochon EAS 800z -> 14_SD_WS07
- CTW600, WH1080 -> 14_SD_WS09
- Hama TS33C, Bresser Thermo/Hygro Sensor -> 14_Hideki
- FreeTec Aussenmodul NC-7344 -> 14_SD_WS07

It is possible to attach more than one device in order to get better reception, fhem will filter out duplicate messages.
Note: this module require the Device::SerialPort or Win32::SerialPort module. It can currently only attatched via USB.

Define
`define <name> SIGNALduino <device>`
USB-connected devices (SIGNALduino):

- <device> specifies the serial port to communicate with the SIGNALduino. 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. If your distribution does not have a cdc_acm module, you can force usbserial to handle the SIGNALduino 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@57600
  This is also the default baudrate It is recommended to specify the device via a name which does not change: e.g. via by-id devicename: /dev/serial/by-id/usb-1a86_USB2.0-Serial-if00-port0@57600 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.

- do_not_notify
- dummy
- debug
  This will bring the module in a very verbose debug output. Usefull to find new signals and verify if the demodulation works correctly.
- flashCommand
  This is the command, that is executed to performa the firmware flash. Do not edit, if you don't know what you are doing.
  The default is: avrdude -p atmega328P -c arduino -P [PORT] -D -U flash:w:[HEXFILE] 2>[LOGFILE]
  It contains some place-holders that automatically get filled with the according values:
  - [PORT]
    is the port the Signalduino is connectd to (e.g. /dev/ttyUSB0) and will be used from the defenition
  - [HEXFILE]
    is the .hex file that shall get flashed. There are three options (applied in this order):
    - passed in set flash
    - taken from the hexFile attribute
    - the default value defined in the module
  - [LOGFILE]
    The logfile that collects information about the flash process. It gets displayed in FHEM after finishing the flash process
- hardware
  When using the flash command, you should specify whar hardware you have connected to the usbport. Doing not, can cause failures of the device.
- minsecs
  This is a very special attribute. It is provided to other modules. minsecs should act like a threshold. All logic must be done in the logical module. If specified, then supported modules will discard new messages if minsecs isn't past.
- longids
  Comma separated list of device-types for SIGNALduino 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. Therfor 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 to not to use long IDs for all devices.
  Examples:

      # Do not use any long IDs for any devices:
      attr sduino longids 0
      # Use any long IDs for all devices (this is default):
      attr sduino longids 1
      # Use longids for BTHR918N devices.
      # Will generate devices names like BTHR918N_f3.
      attr sduino longids BTHR918N

- whitelistIDs
  This attribute allows it, to specify whichs protocos are considured from this module. Protocols which are not considured, will not generate logmessages or events. They are then completly ignored. This makes it possible to lower ressource usage and give some better clearnes in the logs. You can specify multiple whitelistIDs wih a colon : 0,3,7,12
  With a # at the beginnging whitelistIDs can be deactivated.
- WS09_Model
  WS09_WSModel:undef -> check all, WH1080 -> support WH1080/WS0101 , CTW600 -> support CTW600
- WS09_CRCAUS
  WS09_CRCAUS:0,1 WS09_CRCAUS = 0 is default -> check CRC Calculation for WH1080
Get

- version
  return the SIGNALduino firmware version
- raw
  Issue a SIGNALduino firmware command, and wait for one line of data returned by the SIGNALduino. See the SIGNALduino firmware code for details on SIGNALduino commands. With this line, you can send almost any signal via a transmitter connected
- cmds
  Depending on the firmware installed, SIGNALduinos have a different set of possible commands. Please refer to the sourcecode of the firmware of your SIGNALduino to interpret the response of this command. See also the raw- command.
- ITParms
  For sending IT Signals for wireless switches, the number of repeats and the base duration can be set. With the get command, you can verify what is programmed into the uC.
- protocolIDs
  display a list of the protocol IDs

SET

- ITClock
  Sets the clock which is used to send the signal for IT switches. (Default is 300)
- raw
  Issue a SIGNALduino firmware command, without waiting data returned by the SIGNALduino. See the SIGNALduino firmware code for details on SIGNALduino commands. With this line, you can send almost any signal via a transmitter connected To send some raw data look at these examples: P<protocol id>#binarydata#R<num of repeats>#C<optional clock> (#C is optional)
  Example 1: set sduino raw SR;R=3;P0=500;P1=-9000;P2=-4000;P3=-2000;D=0302030 sends the data in raw mode 3 times repeated
  Example 2: set sduino raw SM;R=3;P0=500;C=250;D=A4F7FDDE sends the data manchester encoded with a clock of 250uS
  Example 3: set sduino raw SC;R=3;SR;P0=5000;SM;P0=500;C=250;D=A4F7FDDE sends a combined message of raw and manchester encoded repeated 3 times
  ;
- reset
  This will do a reset of the usb port and normaly causes to reset the uC connected.
- close
  Closes the connection to the device.
- flash [hexFile]
  The SIGNALduino needs the right firmware to be able to receive and deliver the sensor data to fhem. In addition to the way using the arduino IDE to flash the firmware into the SIGNALduino this provides a way to flash it directly from FHEM. There are some requirements:
  - avrdude must be installed on the host
    On a Raspberry PI this can be done with: sudo apt-get install avrdude
  - the hardware attribute must be set if using any other hardware as an Arduino nano
    This attribute defines the command, that gets sent to avrdude to flash the uC.
- sendMsg
  This command will create the needed instructions for sending raw data via the signalduino. Insteaf of specifying the signaldata by your own you specify a protocol and the bits you want to send. The command will generate the needed command, that the signalduino will send this.
  Please note, that this command will work only for MU or MS protocols. You can't transmit manchester data this way.
  Input args are:

  P<protocol id>#binarydata#R<num of repeats>#C<optional clock> (#C is optional)
  Example: P0#0101#R3#C500
  Will generate the raw send command for the message 0101 with protocol 0 and instruct the arduino to send this three times and the clock is 500.
  SR;R=3;P0=500;P1=-9000;P2=-4000;P3=-2000;D=03020302;

- enableMessagetype
  Allows you to enable the message processing for
  - messages with sync (syncedMS),
  - messages without a sync pulse (unsyncedMU)
  - manchester encoded messages (manchesterMC)
  The new state will be saved into the eeprom of your arduino.
- disableMessagetype
  Allows you to disable the message processing for
  - messages with sync (syncedMS),
  - messages without a sync pulse (unsyncedMU)
  - manchester encoded messages (manchesterMC)
  The new state will be saved into the eeprom of your arduino.

### SIGNALduino_un

The SIGNALduino_un module is a testing and debugging module to decode some devices, it will not create any devices, it will catch only all messages from the signalduino which can't be send to another module
Define

`define <name> SIGNALduino_un <code> ]`
You can define a Device, but currently you can do nothing with it. Autocreate is also not enabled for this module. The function of this module is only to output some logging at verbose 4 or higher. May some data is decoded correctly but it's also possible that this does not work. The Module will try to process all messages, which where not handled by other modules.

Set

N/A

Get

N/A

Attributes

- Verbose

### SISPM

Define

`define <name> SISPM </path/to/sispmctl>`
When using multiple SIS PMs on one host, sispmctl up to and including V 2.7 has a bug:

    plug-2:# sispmctl -v -s -d 1 -g all -d 2 -g all

    SiS PM Control for Linux 2.7

    (C) 2004, 2005, 2006, 2007, 2008 by Mondrian Nuessle, (C) 2005, 2006 by Andreas Neuper.
    This program is free software.
    [...]

    Gembird #0 is USB device 013.This device is a 4-socket SiS-PM.
    [...]

    Gembird #1 is USB device 015.This device is a 4-socket SiS-PM.
    [...]

    Accessing Gembird #1 USB device 015
    Status of outlet 1:     on
    Status of outlet 2:     on
    Status of outlet 3:     on
    Status of outlet 4:     on
    Error performing requested action
    Libusb error string: error sending control message: Invalid argument
    Terminating
    *** glibc detected *** sispmctl: double free or corruption (fasttop): 0x000251e0 ***
    [...]

Well, the fix is simple and will be sent upstream, but in case it's not incorporated at the time you need it, here it is; it's easy to apply even by hand ;-)

    --- src/main.c-old      2010-01-19 16:56:15.000000000 +0100
    +++ src/main.c  2010-01-19 16:54:56.000000000 +0100
    @@ -441,7 +441,7 @@
                }
                break;
            case 'd': // replace previous (first is default) device by selected one
    -           if(udev!=NULL) usb_close (udev);
    +           if(udev!=NULL) { usb_close (udev); udev=NULL; }
                devnum = atoi(optarg);
                if(devnum>=count) devnum=count-1;
                break;

Defines a path to the program "sispmctl", which is used to control (locally attached) "Silver Shield Power Manager" devices. Usually these are connected to the local computer via USB, more than one "sispm" device per computer is supported. (Please note that, due to neglections in their USB driver, AVM's Fritz!Box 7170 (and derivates, like Deutsche Telekom's Speedport W901V) is not able to talk to these devices ... The Fritz!Box 72xx and 73xx should be fine.) The communication between FHEM and the Power Manager device is done by using the open source sispmctl program. Thus, for the time being, THIS functionality is only available running FHEM on Linux (or any other platform where you can get the sispmctl program compiled and running). On the bright side: by interfacing via commandline, it is possible to define multiple SISPM devices, e. g. with a wrapper that does execute sispmctl on a remote (Linux) system. And: sispmctl runs happily on Marvells SheevaPlug ;) Please note: if you're not running FHEM as root, you most likely have to make sispmctl setuid root (`chmod 4755 /path/to/sispmctl`) or fiddle with udev so that the devices of the Power Manager are owned by the user running FHEM. After defining a SISPM device, a first test is done, identifying attached PMs. If this succeeds, an internal task is scheduled to read the status every 30 seconds. (Reason being that someone else could have switched sockets externally to FHEM.) To actually control any power sockets, you need to define a SIS_PMS device ;) If autocreate is enabled, those should be autocreated for your convenience as soon as the first scan took place (30 seconds after the define). Implementation of SISPM.pm tries to be nice, that is it reads from the pipe only non-blocking (== if there is data), so it should be safe even to use it via ssh or a netcat-pipe over the Internet, but this, as well, has not been tested extensively yet.
Attributes:

- `model`: `SISPM` (ignored for now)

Example:

`define PMS_Terrarium SISPM /usr/bin/sispmctl`

Set

N/A

Get

N/A

Attributes

- model (SISPM)

### SIS_PMS

This module is responsible for handling the actual sockets (power on, power off, toggle) on a "Silver Shield Power Manager", see SISPM for how to define access to one (SIS_PMS stands for "Silver Shield Power Manager Socket").
Define

`define <name> SIS_PMS <serial> <socket>`
To securely distinguish multiple attached Power Manager devices, the serial number of those is used. You get these with "sispmctl -s" - or just let autocreate define the sockets attached for you.

- `<serial>` is the serial number of the Power Manager device, see above.
- `<socket>` is a number between 1 and 4 (for a 4 socket model)

Examples:

`define lamp SIS_PMS 01:02:03:04:05 1`
`define otherlamp SIS_PMS 01:02:03:04:05 3`
`define tv SIS_PMS 01:01:38:44:55 1`

Set

`set <name> <value> [<time>]`
where `value` is one of:

        off
        on
        toggle
        on-till           # Special, see the note
        off-till          # Special, see the note

Examples:

`set lamp on`
`set lamp1,lamp2,lamp3 on`
`set lamp1-lamp3 on`
`set hql_lamp on-till 18:45`

Notes:

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

Get

N/A

Attributes

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

### SMAEM

Define

`define <name> SMAEM`
Defines a SMA Energy Meter (SMAEM), a bidirectional energy meter/counter used in photovoltaics.
You need at least one SMAEM on your local subnet or behind a multicast enabled network of routers to receive multicast messages from the SMAEM over the multicast group 239.12.255.254 on udp/9522. Multicast messages are sent by SMAEM once a second (firmware 1.02.04.R, March 2016).
The update interval will be set by attribute "interval". If not set, it defaults to 60s. Since the SMAEM sends updates once a second, you can update the readings once a second by lowering the interval to 1 (Not recommended, since it puts FHEM under heavy load).
The parameter "disableSernoInReading" changes the way readings are named: if disableSernoInReading is false or unset, the readings will be named "SMAEM<serialnumber_>.....". If set to true, the prefix "SMAEM<serialnumber_>" is skipped. Set this to true if you only have one SMAEM device on your network and you want shorter reading names. If unsure, leave it unset.
You need the perl module IO::Socket::Multicast. Under Debian (based) systems it can be installed with `apt-get install libio-socket-multicast-perl`.

Attribute

- disableSernoInReading : prevents the prefix "SMAEM<serialnumber_>....."
- feedinPrice : the individual amount of refund of one kilowatt hour
- interval : evaluation interval in seconds
- disable : 1 = the module is disabled
- diffAccept : diffAccept determines the threshold, up to that a calaculated difference between two straight sequently meter readings (Readings with *_Diff) should be commenly accepted (default = 10).
  Hence faulty DB entries with a disproportional high difference values will be eliminated, don't tamper the result and the measure cycles will be discarded.
- powerCost : die individuelle Höhe der Stromkosten pro Kilowattstunde
- timeout : Einstellung des timeout für die Wechselrichterabfrage (default 60s)

### SMAInverter

Module for the integration of a SMA Inverter over it's Speedwire (=Ethernet) Interface.
Tested on Sunny Tripower 6000TL-20 and Sunny Island 4.4 with Speedwire/Webconnect Piggyback.
Questions and discussions about this module you can find in the FHEM-Forum link:
76_SMAInverter.pm - Abfrage von SMA Wechselrichter.
Requirements
This module requires:

- Perl Module: IO::Socket::INET (apt-get install libio-socket-multicast-perl)
- Perl Module: Date::Time (apt-get install libdatetime-perl)
- Perl Module: Time::HiRes
- FHEM Module: 99_SUNRISE_EL.pm
- FHEM Module: Blocking.pm

Define

`define <name> SMAInverter <pin> <hostname/ip>`
- pin: User-Password of the SMA Inverter. Default is 0000. Can be changed by "Sunny Explorer" Windows Software
- hostname/ip: Hostname or IP-Adress of the inverter (or it's speedwire piggyback module).
- Port of the inverter is 9522 by default. Firewall has to allow connection on this port !

Operation method

The module sends commands to the inverter and checks if they are supported by the inverter.
In case of a positive answer the data is collected and displayed in the readings according to the detail-level.
If more than one inverter is installed, set attributes "target-susyid" and "target-serial" with an appropriate value.
The normal operation time of the inverter is supposed from sunrise to sunset. In that time period the inverter will be polled. The time of sunrise and sunset will be calculated by functions of FHEM module 99_SUNRISE_EL.pm which is loaded automatically by default. Therefore the global attribute "longitude" and "latitude" should be set to determine the position of the solar system (see Commandref SUNRISE_EL).
By the attribute "suppressSleep" the sleep mode between sunset and sunrise can be suppressed. Using attribute "offset" you may prefer the sunrise and defer the sunset virtually. So the working period of the inverter will be extended.
In operating mode "automatic" the inverter will be requested periodically corresponding the preset attribute "interval". The operating mode can be switched to "manual" to realize the retrieval manually (e.g. to synchronize the requst with a SMA energy meter by notify).
During inverter operating time the average energy production of the last 5, 10 and 15 minutes will be calculated and displayed in the readings "avg_power_lastminutes_05", "avg_power_lastminutes_10" and "avg_power_lastminutes_15". Note: To permit a precise calculation, you should also set the real request interval into the attribute "interval" although you would use the "manual" operation mode !
The retrieval of the inverter will be executed non-blocking. You can adjust the timeout value for this background process by attribute "timeout".

Get

`get <name> data`
The request of the inverter will be executed. Those possibility is especifically created for the "manual" operation mode (see attribute "mode").

Attributes

- interval : Queryintreval in seconds
- detail-level : "0" - Only Power and Energy / "1" - Including Voltage and Current / "2" - All values
- disable : 1 = the module is disabled
- mode : automatic = the inverter will be polled by preset interval, manual = query only by command "get <name> data"
- offset : time in seconds to prefer the sunrise respectively defer the sunset virtualy (0 ... 7200). You will be able to extend the working period of the module.
- SBFSpotComp : 1 = the readings are created like SBFSpot-style
- suppressSleep : the sleep mode (after sunset, before sunrise) is deactivated and the inverter will be polled continuously.
- showproctime : shows processing time in background and wasted time to retrieve inverter data
- target-susyid : In case of a Multigate the target SUSyID can be defined. If more than one inverter is installed you have to set the inverter-SUSyID to assign the inverter to the device definition. Default is 0xFFFF, means any SUSyID
- target-serial : In case of a Multigate the target Serialnumber can be defined. If more than one inverter is installed you have to set the inverter-Serialnumber to assign the inverter to the device definition. Default is 0xFFFFFFFF, means any Serialnumber
- timeout : setup timeout of inverter data request (default 60s)

Readings

- BAT_CYCLES / bat_cycles : Battery recharge cycles
- BAT_IDC / bat_idc : Battery Current
- BAT_TEMP / bat_temp : Battery temperature
- BAT_UDC / bat_udc : Battery Voltage
- ChargeStatus / chargestatus : Battery Charge status
- CLASS / device_class : Inverter Class
- PACMAX1 / pac_max_phase_1 : Nominal power in Ok Mode
- PACMAX1_2 / pac_max_phase_1_2 : Maximum active power device (Some inverters like SB3300/SB1200)
- PACMAX2 / pac_max_phase_2 : Nominal power in Warning Mode
- PACMAX3 / pac_max_phase_3 : Nominal power in Fault Mode
- Serialnumber / serial_number : Inverter Serialnumber
- SPOT_ETODAY / etoday : Today yield
- SPOT_ETOTAL / etotal : Total yield
- SPOT_FEEDTM / feed-in_time : Feed-in time
- SPOT_FREQ / grid_freq. : Grid Frequency
- SPOT_IAC1 / phase_1_iac : Grid current phase L1
- SPOT_IAC2 / phase_2_iac : Grid current phase L2
- SPOT_IAC3 / phase_3_iac : Grid current phase L3
- SPOT_IDC1 / string_1_idc : DC current input
- SPOT_IDC2 / string_2_idc : DC current input
- SPOT_OPERTM / operation_time : Operation Time
- SPOT_PAC1 / phase_1_pac : Power L1
- SPOT_PAC2 / phase_2_pac : Power L2
- SPOT_PAC3 / phase_3_pac : Power L3
- SPOT_PACTOT / total_pac : Total Power
- SPOT_PDC1 / string_1_pdc : DC power input 1
- SPOT_PDC2 / string_2_pdc : DC power input 2
- SPOT_UAC1 / phase_1_uac : Grid voltage phase L1
- SPOT_UAC2 / phase_2_uac : Grid voltage phase L2
- SPOT_UAC3 / phase_3_uac : Grid voltage phase L3
- SPOT_UDC1 / string_1_udc : DC voltage input
- SPOT_UDC2 / string_2_udc : DC voltage input
- SUSyID / susyid : Inverter SUSyID
- INV_TEMP / device_temperature : Inverter temperature
- INV_TYPE / device_type : Inverter Type
- POWER_IN / power_in : Battery Charging power
- POWER_OUT / power_out : Battery Discharging power
- INV_GRIDRELAY / gridrelay_status : Grid Relay/Contactor Status
- INV_STATUS / device_status : Inverter Status
- opertime_start : Begin of iverter operating time corresponding the calculated time of sunrise with consideration of the attribute "offset" (if set)
- opertime_stop : End of iverter operating time corresponding the calculated time of sunrise with consideration of the attribute "offset" (if set)
- modulstate : shows the current module state "normal" or "sleep" if the inverter won't be requested at the time.
- avg_power_lastminutes_05 : average power of the last 5 minutes.
- avg_power_lastminutes_10 : average power of the last 10 minutes.
- avg_power_lastminutes_15 : average power of the last 15 minutes.
- inverter_processing_time : wasted time to retrieve the inverter data
- background_processing_time : total wasted time by background process (BlockingCall)

### SMARTMON

This module is a FHEM frontend to the Linux tool smartctl. It provides various information on the SMART System of the hard drive.
Define
`define <name> SMARTMON <device> [<Interval>]`
This statement creates a new SMARTMON instance. The parameters specify a device to be monitored and the update interval in minutes.
Example: `define sm SMARTMON /dev/sda 60`
Readings:

- overall_health_test
  Specifies the general condition of the HDD (PASSED or FAILED).
- warnings
  Specifies the number of stored alerts.
Furthermore, the available SMART parameters can be displayed as Readings (RAW and / or (partially) interpreted).

Get:

- version
  Displays the module version.
- update
  Updates all readings.
- list
  Displays various information:
  - devices:
    List of available devices in the system.
  - info:
    Information about the current device.
  - data:
    List of SMART parameters for the current device.
  - health:
    Information about overall health status for the device.
  For the Last 3 commands can also be another Device specified (as an additional parameter).

Attributes:

- show_raw
  Valid values: 0: no RAW Readings (default), 1: show all, are not included in interpreted Readings, 2: show all.
- include
  Comma separated list of IDs for desired SMART parameters. If nothing passed, all available values are displayed.
- disable
  Valid values: 0: Module active (default), 1: module is disabled (no updates).
- parameters
  Additional values for smartctl.

For more information see cmartctrl documentation.

### SMASTP

Module for the integration of a Sunny Tripower Inverter build by SMA over it's Speedwire (=Ethernet) Interface.
Tested on Sunny Tripower 6000TL-20, 10000-TL20 and 10000TL-10 with Speedwire/Webconnect Piggyback.

Define

`define <name> SMASTP <pin> <hostname/ip> [port]`
- pin: User-Password of the SMA STP Inverter. Default is 0000. Can be changed by "Sunny Explorer" Windows Software
- hostname/ip: Hostname or IP-Adress of the inverter (or it's speedwire piggyback module).
- port: Port of the inverter. 9522 by default.

Modus

The module automatically detects the inactvity of the inverter due to a lack of light (night).
This inactivity is therefore called "nightmode". During nightmode, the inverter is not queried over the network.
By default nightmode is between 9pm and 5am. This can be changed by "starttime" (start of inverter
operation, end of nightmode) and "endtime" (end of inverter operation, start of nightmode).
Further there is the inactivitymode: in inactivitymode, the inverter is queried but readings are not updated.

Parameter

- interval: Queryintreval in seconds
- suppress-night-mode: The nightmode is deactivated
- suppress-inactivity-mode: The inactivitymode is deactivated
- starttime: Starttime of inverter operation (default 5am)
- endtime: Endtime of inverter operation (default 9pm)
- force-sleepmode: The nightmode is activated on inactivity, even the endtime is not reached
- enable-modulstate: Turns the reading "modulstate" (normal / inactive / sleeping) on
- alarm1-value, alarm2-value, alarm3-value: Set an alarm on the reading SpotP in watt.
  The readings Alarm1..Alarm3 are set accordingly: -1 for SpotP < alarmX-value and 1 for SpotP >= alarmX-value

Readings

- SpotP: spotpower - Current power in watt delivered by the inverter
- AvP01: average power 1 minute: average power in watt of the last minute
- AvP05: average power 5 minutes: average power in watt of the five minutes
- AvP15: average power 15 minutes: average power in watt of the fifteen minutes
- SpotPDC1: current d.c. voltage delivered by string 1
- SpotPDC2: current d.c. voltage delivered by string 2
- TotalTodayP: generated power in Wh of the current day
- AlltimeTotalP: all time generated power in Wh
- Alarm1..3: alrm trigger 1..3. Set by parameter alarmN-value

### SML

This module supports "Intelligenter Strom Zhler"(ENBW) and "Sparzhler" (Yellow Strom).
The electricity meter will be polled in a defined interval (1-100) for new values.

Define
`define <name> SML <host> <port> [<interval> <timeout>]`

Example:
define StromZ1 SML 192.168.178.20
define StromZ2 SML 192.168.10.25 60 60

Set
set <name> <value> <nummber>
where value is one of:

- `TOTALPOWER`
- `YEARPOWER`
- `MONTHPOWER`
- `DAYPOWER`
- `Interval`

Example:
set <name> TOTALPOWER 12345
Get
get <name> <value>
where value is one of:

- `TOTALPOWER`
- `YEARPOWER`
- `MONTHPOWER`
- `DAYPOWER`
- `Interval`

Example:
get <name> DAYPOWER
get <name> YEARPOWER

### SOMFY - Somfy RTS / Simu Hz protocol

The Somfy RTS (identical to Simu Hz) protocol is used by a wide range of devices, which are either senders or receivers/actuators. Right now only SENDING of Somfy commands is implemented in the CULFW, so this module currently only supports devices like blinds, dimmers, etc. through a CUL device (which must be defined first). Reception of Somfy remotes is only supported indirectly through the usage of an FHEMduino http://www.fhemwiki.de/wiki/FHEMduino which can then be used to connect to the SOMFY device.
Define

`define <name> SOMFY <address> [<encryption-key>] [<rolling-code>]`
The address is a 6-digit hex code, that uniquely identifies a single remote control channel. It is used to pair the remote to the blind or dimmer it should control.
Pairing is done by setting the blind in programming mode, either by disconnecting/reconnecting the power, or by pressing the program button on an already associated remote.
Once the blind is in programming mode, send the "prog" command from within FHEM to complete the pairing. The blind will move up and down shortly to indicate completion.
You are now able to control this blind from FHEM, the receiver thinks it is just another remote control.

- `<address>` is a 6 digit hex number that uniquely identifies FHEM as a new remote control channel.
  You should use a different one for each device definition, and group them using a structure.
- The optional `<encryption-key>` is a 2 digit hex number (first letter should always be A) that can be set to clone an existing remote control channel.
- The optional `<rolling-code>` is a 4 digit hex number that can be set to clone an existing remote control channel.
  If you set one of them, you need to pick the same address as an existing remote. Be aware that the receiver might not accept commands from the remote any longer,
  if you used FHEM to clone an existing remote.
  This is because the code is original remote's codes are out of sync.

Examples:

`define rollo_1 SOMFY 000001`
`define rollo_2 SOMFY 000002`
`define rollo_3_original SOMFY 42ABCD A5 0A1C`

Set

`set <name> <value> [<time>]`
where `value` is one of:

        on
        off
        go-my
        stop
        pos value (0..100) # see note
        prog  # Special, see note
        on-for-timer
        off-for-timer

Examples:

`set rollo_1 on`
`set rollo_1,rollo_2,rollo_3 on`
`set rollo_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 (eg. by pressing the program-button on the original remote) and send the "prog" command from FHEM to finish pairing.
  The blind will move up and down shortly to indicate success.
- on-for-timer and off-for-timer send a stop command after the specified time, instead of reversing the blind.
  This can be used to go to a specific position by measuring the time it takes to close the blind completely.
- 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. See also positionInverse attribute.

The position reading distinuishes between multiple cases

- Without timing values (see attributes) 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. An example for the physical device is a CUL.
  Note: The IODev has to be set, otherwise no commands will be sent!
  If you have both a CUL868 and CUL433, use the CUL433 as IODev for increased range.
- positionInverse
  Inverse operation for positions instead of 0 to 100-200 the positions are ranging from 100 to 10 (down) and then to 0 (closed). The pos set command will point in this case to the reversed pos values. This does NOT reverse the operation of the on/off command, meaning that on always will move the shade down and off will move it up towards the initial position.
- 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.
- rolling-code < 4 digit hex >
  Can be used to overwrite the rolling-code manually with a new value (rolling-code will be automatically increased with every command sent) This requires also setting enc-key: only with bot attributes set the value will be accepted for the internal reading
- enc-key < 2 digit hex >
  Can be used to overwrite the enc-key manually with a new value This requires also setting rolling-code: only with bot attributes set the value will be accepted for the internal reading
- 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
- model
  The model attribute denotes the model type of the device. The attributes will (currently) not be used by the fhem.pl directly. It can be used by e.g. external programs or web interfaces to distinguish classes of devices and send the appropriate commands (e.g. "on" or "off" to a switch, "dim..%" to dimmers etc.).
  The spelling of the model names are as quoted on the printed documentation which comes which each device. This name is used without blanks in all lower-case letters. Valid characters should be `a-z 0-9` and `-` (dash), other characters should be ommited.
  Here is a list of "official" devices:
  Receiver/Actor: somfyblinds
- 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.
  Note: If set, this value always needs to be higher than drive-down-time-to-100 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).
  Note: If set, this value always needs to be higher than drive-down-time-to-100 This value is usually a bit higher than "drive-down-time-to-close", due to the blind's weight.

### SONOS

FHEM-Module to communicate with the Sonos-System via UPnP

For more informations have also a closer look at the wiki at http://www.fhemwiki.de/wiki/SONOS

For correct functioning of this module it is neccessary to have some Perl-Modules installed, which are eventually installed already manually:

- `LWP::Simple`
- `LWP::UserAgent`
- `SOAP::Lite`
- `HTTP::Request`

Installation e.g. as Debian-Packages (via "sudo apt-get install <packagename>"):

- LWP::Simple-Packagename (incl. LWP::UserAgent and HTTP::Request): libwww-perl
- SOAP::Lite-Packagename: libsoap-lite-perl

Installation e.g. as Windows ActivePerl (via Perl-Packagemanager)

- Install Package LWP (incl. LWP::UserAgent and HTTP::Request)
- Install Package SOAP::Lite
- SOAP::Lite-Special for Versions after 5.18:
  - Add another Packagesource from suggestions or manual: Bribes de Perl (http://www.bribes.org/perl/ppm)
  - Install Package: SOAP::Lite

Windows ActivePerl 5.20 does currently not work due to missing SOAP::Lite

Attention!
This Module will not work on any platform, because of the use of Threads and the neccessary Perl-modules.

More information is given in a (german) Wiki-article: http://www.fhemwiki.de/wiki/SONOS

The system consists of two different components:
1. A UPnP-Client which runs as a standalone process in the background and takes the communications to the sonos-components.
2. The FHEM-module itself which connects to the UPnP-client to make fhem able to work with sonos.
The client will be started by the module itself if not done in another way.
You can start this client on your own (to let it run instantly and independent from FHEM):
`perl 00_SONOS.pm 4711`: Starts a UPnP-Client in an independant way who listens to connections on port 4711. This process can run a long time, FHEM can connect and disconnect to it.

#### Example

Simplest way to define:
`define Sonos SONOS`

Example with control over the used port and the isalive-checker-interval:
`define Sonos SONOS localhost:4711 45`

#### Define

`define <name> SONOS [upnplistener [interval [waittime [delaytime]]]]`
Define a Sonos interface to communicate with a Sonos-System.

`[upnplistener]`
The name and port of the external upnp-listener. If not given, defaults to `localhost:4711`. The port has to be a free portnumber on your system. If you don't start a server on your own, the script does itself.
If you start it yourself write down the correct informations to connect.

`[interval]`
The interval is for alive-checking of Zoneplayer-device, because no message come if the host disappear :-)
If omitted a value of 10 seconds is the default.

`[waittime]`
With this value you can configure the waiting time for the starting of the Subprocess.

`[delaytime]`
With this value you can configure a delay time before starting the network-part.

#### Set

- Common Tasks
  - `RescanNetwork`
    Restarts the player discovery.
- Control-Commands
  - `Mute <state>`
    Sets the mute-state on all players.
  - `PauseAll`
    Pause all Zoneplayer.
  - `Pause`
    Alias for PauseAll.
  - `StopAll`
    Stops all Zoneplayer.
  - `Stop`
    Alias for StopAll.
- Bookmark-Commands
  - `DisableBookmark <Groupname>`
    Disables the group with the given name.
  - `EnableBookmark <Groupname>`
    Enables the group with the given name.
  - `LoadBookmarks [Groupname]`
    Loads the given group (or all if parameter not set) from the filesystem.
  - `SaveBookmarks [Groupname]`
    Saves the given group (or all if parameter not set) to the filesystem.
- Group-Commands
  - `Groups <GroupDefinition>`
    Sets the current groups on the whole Sonos-System. The format is the same as retreived by getter 'Groups'.
    A reserved word is Reset. It can be used to directly extract all players out of their groups.

#### Get

- Group-Commands
  - `Groups`
    Retreives the current group-configuration of the Sonos-System. The format is a comma-separated List of Lists with devicenames e.g. `[Sonos_Kueche], [Sonos_Wohnzimmer, Sonos_Schlafzimmer]`. In this example there are two groups: the first consists of one player and the second consists of two players.
    The order in the sublists are important, because the first entry defines the so-called group-coordinator (in this case `Sonos_Wohnzimmer`), from which the current playlist and the current title playing transferred to the other member(s).

#### Attributes

'''Attention'''
The most of the attributes can only be used after a restart of fhem, because it must be initially transfered to the subprocess.

- Common
  - `disable <value>`
    One of (0,1). With this value you can disable the whole module. Works immediatly. If set to 1 the subprocess will be terminated and no message will be transmitted. If set to 0 the subprocess is again started.
    It is useful when you install new Sonos-Components and don't want any disgusting devices during the Sonos setup.
  - `ignoredIPs <IP-Address>[,IP-Address]`
    With this attribute you can define IP-addresses, which has to be ignored by the UPnP-System of this module. e.g. "192.168.0.11,192.168.0.37"
  - `pingType <string>`
    One of (none,tcp,udp,icmp,syn). Defines which pingType for alive-Checking has to be used. If set to 'none' no checks will be done.
  - `usedonlyIPs <IP-Adresse>[,IP-Adresse]`
    With this attribute you can define IP-addresses, which has to be exclusively used by the UPnP-System of this module. e.g. "192.168.0.11,192.168.0.37"
- Bookmark Configuration
  - `bookmarkSaveDir <path>`
    Defines a directory where the saved bookmarks can be placed. If not defined, "." will be used.
  - `bookmarkTitleDefinition <Groupname>:<PlayerdeviceRegEx>:<TrackURIRegEx>:<MinTitleLength>:<RemainingLength>:<MaxAge>:<ReadOnly>`
    Definition of Bookmarks for titles.
  - `bookmarkPlaylistDefinition <Groupname>:<PlayerdeviceRegEx>:<MinListLength>:<MaxListLength>:<MaxAge>`
    Definition of bookmarks for playlists.
- Proxy Configuration
  - `generateProxyAlbumArtURLs <int>`
    One of (0, 1). If defined, all Cover-Links (the readings "currentAlbumArtURL" and "nextAlbumArtURL") are generated as links to the internal Sonos-Module-Proxy. It can be useful if you access Fhem over an external proxy and therefore have no access to the local network (the URLs are direct URLs to the Sonosplayer instead).
  - `proxyCacheDir <Path>`
    Defines a directory where the cached Coverfiles can be placed. If not defined "/tmp" will be used.
  - `proxyCacheTime <int>`
    A time in seconds. With a definition other than "0" the caching mechanism of the internal Sonos-Module-Proxy will be activated. If the filetime of the chached cover is older than this time, it will be reloaded from the Sonosplayer.
- Speak Configuration
  - `targetSpeakDir <string>`
    Defines, which Directory has to be used for the Speakfiles
  - `targetSpeakMP3FileConverter <string>`
    Defines an MP3-File converter, which properly converts the resulting speaking-file. With this option you can avoid timedisplay problems. Please note that the waittime before the speaking starts can increase with this option be set.
  - `targetSpeakMP3FileDir <string>`
    The directory which should be used as a default for text-embedded MP3-Files.
  - `targetSpeakURL <string>`
    Defines, which URL has to be used for accessing former stored Speakfiles as seen from the SonosPlayer
  - `targetSpeakFileTimestamp <int>`
    One of (0, 1). Defines, if the Speakfile should have a timestamp in his name. That makes it possible to store all historical Speakfiles.
  - `targetSpeakFileHashCache <int>`
    One of (0, 1). Defines, if the Speakfile should have a hash-value in his name. If this value is set to one an already generated file with the same hash is re-used and not newly generated.
  - `Speak1 <Fileextension>:<Commandline>`
    Defines a systemcall commandline for generating a speaking file out of the given text. If such an attribute is defined, an associated setter at the Sonosplayer-Device is available. The following placeholders are available:
    '''%language%''': Will be replaced by the given language-parameter
    '''%filename%''': Will be replaced by the complete target-filename (incl. fileextension).
    '''%text%''': Will be replaced with the given text.
    '''%textescaped%''': Will be replaced with the given url-encoded text.
  - `Speak2 <Fileextension>:<Commandline>`
    See Speak1
  - `Speak3 <Fileextension>:<Commandline>`
    See Speak1
  - `Speak4 <Fileextension>:<Commandline>`
    See Speak1
  - `SpeakCover <Filename>`
    Defines a Cover for use by the speak generation process. If not defined the Fhem-logo will be used.
  - `Speak1Cover <Filename>`
    See SpeakCover
  - `Speak2Cover <Filename>`
    See SpeakCover
  - `Speak3Cover <Filename>`
    See SpeakCover
  - `Speak4Cover <Filename>`
    See SpeakCover
  - `SpeakGoogleURL <GoogleURL>`
    The google-speak-url that has to be used. If empty a default will be used. You have to define placeholders for replacing the language- and text-value: %1$s -> Language, %2$s -> Text
    The Default-URL is currently: `http://translate.google.com/translate_tts?tl=%1$s&client=tw-ob&q=%2$s`

### SONOSPLAYER

FHEM module to work with a Sonos Zoneplayer

For more informations have also a closer look at the wiki at http://www.fhemwiki.de/wiki/SONOS

Normally you don't have to define a Sonosplayer-Device on your own, because the Sonos-Device will do this for you during the discovery-process.

#### Example

`define Sonos_Wohnzimmer SONOSPLAYER RINCON_000EFEFEFEF401400_MR`

#### Define

`define <name> SONOSPLAYER <udn>`

`<udn>`
MAC-Address based identifier of the zoneplayer

#### Set

- Common Tasks
  - `Alarm (Create|Update|Delete|Enable|Disable) <ID[,ID]|All> <Datahash>`
    Can be used for working on alarms:
    - Create: Creates an alarm-entry with the given datahash.
    - Update: Updates the alarm-entry with the given id(s) and datahash.
    - Delete: Deletes the alarm-entry with the given id(s).
    - Enable: Enables the alarm-entry with the given id(s).
    - Disable: Disables the alarm-entry with the gven id(s).
    If the Word 'All' is given as ID, all alarms of this player are changed.
    The Datahash:
    The Format is a perl-hash and is interpreted with the eval-function.
    e.g.: { Repeat => 1 }
    The following entries are allowed/neccessary:
    - StartTime
    - Duration
    - Recurrence_Once
    - Recurrence_Monday
    - Recurrence_Tuesday
    - Recurrence_Wednesday
    - Recurrence_Thursday
    - Recurrence_Friday
    - Recurrence_Saturday
    - Recurrence_Sunday
    - Enabled
    - ProgramURI
    - ProgramMetaData
    - Shuffle
    - Repeat
    - Volume
    - IncludeLinkedZones
    e.g.:
    - set Sonos_Wohnzimmer Alarm Create 0 { Enabled => 1, Volume => 35, StartTime => '00:00:00', Duration => '00:15:00', Repeat => 0, Shuffle => 0, ProgramURI => 'x-rincon-buzzer:0', ProgramMetaData => '', Recurrence_Once => 0, Recurrence_Monday => 1, Recurrence_Tuesday => 1, Recurrence_Wednesday => 1, Recurrence_Thursday => 1, Recurrence_Friday => 1, Recurrence_Saturday => 0, Recurrence_Sunday => 0, IncludeLinkedZones => 0 }
    - set Sonos_Wohnzimmer Alarm Update 17 { Shuffle => 1 }
    - set Sonos_Wohnzimmer Alarm Delete 17 {}
  - `AudioDelay <Level>`
    Sets the audiodelay of the player to the given value. The value can range from 0 to 5.
  - `AudioDelayLeftRear <Level>`
    Sets the audiodelayleftrear of the player to the given value. The value can range from 0 to 2. The values has the following meanings: 0: >3m, 1: >0.6m und <3m, 2: <0.6m
  - `AudioDelayRightRear <Level>`
    Sets the audiodelayrightrear of the player to the given value. The value can range from 0 to 2. The values has the following meanings: 0: >3m, 1: >0.6m und <3m, 2: <0.6m
  - `DailyIndexRefreshTime <Timestring>`
    Sets the current DailyIndexRefreshTime for the whole bunch of Zoneplayers.
  - `DialogLevel <State>`
    Sets the dialoglevel for playbar-systems.
  - `ExportSonosBibliothek <filename>`
    Exports a file with a textual representation of a structure- and titlehash of the complete Sonos-Bibliothek. Warning: Will use a large amount of CPU-Time and RAM!
  - `Name <Zonename>`
    Sets the Name for this Zone
  - `NightMode <State>`
    Sets the nightmode for playbar-systems.
  - `OutputFixed <State>`
    Sets the outputfixed-state. Retrieves the new state as the result.
  - `Reboot`
    Initiates a reboot on the Zoneplayer.
  - `ResetAttributesToDefault <DeleteAllOtherAttributes>`
    Sets the attributes to the inital state. If the parameter "DeleteAllOtherAttributes" is set to "1" or "on", all attributes will be deleted before the defaults will be newly retrieved from the player and set.
  - `RoomIcon <Iconname>`
    Sets the Icon for this Zone
  - `SnoozeAlarm <Timestring|Seconds>`
    Snoozes a currently playing alarm for the given time
  - `SubEnable <State>`
    Sets the substate for sub-systems.
  - `SubGain <Level>`
    Sets the sub-gain for sub-systems. The value can range from -15 to 15.
  - `SubPolarity <Level>`
    Sets the sub-polarity for sub-systems. The value can range from 0 to 2.
  - `SurroundEnable <State>`
    Sets the surround-state for surround-systems (like playbars).
  - `SurroundLevel <Level>`
    Sets the surround-level for surround-systems (like playbars). The value can range from -15 to 15.
  - `TruePlay <State>`
    Sets the TruePlay-State of the given player.
  - `Wifi <State>`
    Sets the WiFi-State of the given Player. Can be 'off', 'persist-off' or 'on'.
- Playing Control-Commands
  - `CurrentTrackPosition <TimePosition>`
    Sets the current timeposition inside the title to the given value.
  - `Pause`
    Pause the playing
  - `Previous`
    Jumps to the beginning of the previous title.
  - `Play`
    Starts playing
  - `PlayURI <songURI> [Volume]`
    Plays the given MP3-File with the optional given volume.
  - `PlayURITemp <songURI> [Volume]`
    Plays the given MP3-File with the optional given volume as a temporary file. After playing it, the whole state is reconstructed and continues playing at the former saved position and volume and so on. If the file given is a stream (exactly: a file where the running time could not be determined), the call would be identical to `,PlayURI`, e.g. nothing is restored after playing.
  - `Next`
    Jumps to the beginning of the next title
  - `Speak <Volume> <Language> <Text>`
    Uses the Google Text-To-Speech-Engine for generating MP3-Files of the given text and plays it on the SonosPlayer. Possible languages can be obtained from Google. e.g. "de", "en", "fr", "es"...
  - `StartFavourite <Favouritename> [NoStart]`
    Starts the named sonos-favorite. The parameter should be URL-encoded for proper naming of lists with special characters. If the Word 'NoStart' is given as second parameter, than the Loading will be done, but the playing-state is leaving untouched e.g. not started.
    Additionally it's possible to use a regular expression as the name. The first hit will be used. The format is e.g. `/meine.hits/`.
  - `StartPlaylist <Playlistname> [EmptyQueueBeforeImport]`
    Loads the given Playlist and starts playing immediately. For all Options have a look at "LoadPlaylist".
  - `StartRadio <Radiostationname>`
    Loads the named radiostation (favorite) and starts playing immediately. For all Options have a look at "LoadRadio".
  - `StartSearchlist <Categoryname> <CategoryElement> [[TitlefilterRegEx]/[AlbumfilterRegEx]/[ArtistfilterRegEx] [maxElem]]`
    Loads the searchlist and starts playing immediately. For all Options have a look at "LoadSearchlist".
  - `Stop`
    Stops the playing
  - `Track <TrackNumber|Random>`
    Sets the track with the given tracknumber as the current title. If the tracknumber is the word `Random` a random track will be selected.
- Playing Settings
  - `Balance <BalanceValue>`
    Sets the balance to the given value. The value can range from -100 (full left) to 100 (full right). Retrieves the new balancevalue as the result.
  - `Bass <BassValue>`
    Sets the bass to the given value. The value can range from -10 to 10. Retrieves the new bassvalue as the result.
  - `CrossfadeMode <State>`
    Sets the crossfade-mode. Retrieves the new mode as the result.
  - `LEDState <State>`
    Sets the LED state. Retrieves the new state as the result.
  - `Loudness <State>`
    Sets the loudness-state. Retrieves the new state as the result.
  - `Mute <State>`
    Sets the mute-state. Retrieves the new state as the result.
  - `MuteT`
    Toggles the mute state. Retrieves the new state as the result.
  - `Repeat <State>`
    Sets the repeat-state. Retrieves the new state as the result.
  - `RepeatOne <State>`
    Sets the repeatOne-state. Retrieves the new state as the result.
  - `RepeatOneT`
    Toggles the repeatOne-state. Retrieves the new state as the result.
  - `RepeatT`
    Toggles the repeat-state. Retrieves the new state as the result.
  - `Shuffle <State>`
    Sets the shuffle-state. Retrieves the new state as the result.
  - `ShuffleT`
    Toggles the shuffle-state. Retrieves the new state as the result.
  - `SleepTimer <Timestring|Seconds>`
    Sets the Sleeptimer to the given Time. It must be in the full format of "HH:MM:SS". Deactivate with "00:00:00" or "off".
  - `Treble <TrebleValue>`
    Sets the treble to the given value. The value can range from -10 to 10. Retrieves the new treblevalue as the result.
  - `Volume <VolumeLevel> [RampType]`
    Sets the volume to the given value. The value could be a relative value with + or - sign. In this case the volume will be increased or decreased according to this value. Retrieves the new volume as the result.
    Optional can be a RampType defined with a value between 1 and 3 which describes different templates defined by the Sonos-System.
  - `VolumeD`
    Turns the volume by volumeStep-ticks down.
  - `VolumeRestore`
    Restores the volume of a formerly saved volume.
  - `VolumeSave <VolumeLevel>`
    Sets the volume to the given value. The value could be a relative value with + or - sign. In this case the volume will be increased or decreased according to this value. Retrieves the new volume as the result. Additionally it saves the old volume to a reading for restoreing.
  - `VolumeU`
    Turns the volume by volumeStep-ticks up.
- Control the current Playlist
  - `AddURIToQueue <songURI>`
    Adds the given MP3-File at the current position into the queue.
  - `CurrentPlaylist`
    Sets the current playing to the current queue, but doesn't start playing (e.g. after hearing of a radiostream, where the current playlist still exists but is currently "not in use")
  - `DeleteFromQueue <index_of_elems>`
    Deletes the elements from the current queue with the given indices. You can use the ususal perl-array-formats like "1..12,17,20..22". The indices reference to the position in the current view of the list (this usually differs between the normal playmode and the shuffleplaymode).
  - `DeletePlaylist`
    Deletes the Sonos-Playlist with the given name. According to the possibilities of the playlistname have a close look at LoadPlaylist.
  - `EmptyPlaylist`
    Clears the current queue
  - `LoadFavourite <Favouritename>`
    Loads the named sonos-favorite. The parameter should be URL-encoded for proper naming of lists with special characters.
    Additionally it's possible to use a regular expression as the name. The first hit will be used. The format is e.g. `/meine.hits/`.
  - `LoadPlaylist <Playlistname|Fhem-Devicename> [EmptyQueueBeforeImport]`
    Loads the named playlist to the current playing queue. The parameter should be URL-encoded for proper naming of lists with special characters. The Playlistnamen can be an Fhem-Devicename, then the current playlist of this referenced player will be copied. The Playlistname can also be a filename and then must be startet with 'file:' (e.g. 'file:c:/Test.m3u')
    If EmptyQueueBeforeImport is given and set to 1, the queue will be emptied before the import process. If not given, the parameter will be interpreted as 1.
    Additionally it's possible to use a regular expression as the name. The first hit will be used. The format is e.g. `/hits.2014/`.
  - `LoadRadio <Radiostationname>`
    Loads the named radiostation (favorite). The current queue will not be touched but deactivated. The parameter should be URL-encoded for proper naming of lists with special characters.
    Additionally it's possible to use a regular expression as the name. The first hit will be used. The format is e.g. `/radio/`.
  - `LoadSearchlist <Categoryname> <CategoryElement> [[TitlefilterRegEx]/[AlbumfilterRegEx]/[ArtistfilterRegEx] [[*]maxElem[+|-]]]`
    Loads titles from the Sonos-Bibliothek into the current playlist according to the given category and filtervalues. Please consult the (german) Wiki for detailed informations.
  - `SavePlaylist <Playlistname>`
    Saves the current queue as a playlist with the given name. An existing playlist with the same name will be overwritten. The parameter should be URL-encoded for proper naming of lists with special characters. The Playlistname can be a filename and then must be startet with 'file:' (e.g. 'file:c:/Test.m3u')
- Groupcontrol
  - `AddMember <devicename>`
    Adds the given devicename to the current device as a groupmember. The current playing of the current device goes on and will be transfered to the given device (the new member).
  - `CreateStereoPair <rightPlayerDevicename>`
    Adds the given devicename to the current device as the right speaker of a stereopair. The current playing of the current device goes on (as left-side speaker) and will be transfered to the given device (as right-side speaker).
  - `GroupMute <State>`
    Sets the mute state of the complete group in one step. The value can be on or off.
  - `GroupVolume <VolumeLevel>`
    Sets the group-volume in the way the original controller does. This means, that the relative volumelevel between the different players will be saved during change.
  - `GroupVolumeD`
    Turns the group volume by volumeStep-ticks down.
  - `GroupVolumeU`
    Turns the group volume by volumeStep-ticks up.
  - `MakeStandaloneGroup`
    Makes this Player a standalone group.
  - `RemoveMember <devicename>`
    Removes the given device, so that they both are not longer a group. The current playing of the current device goes on normally. The cutted device stops his playing and has no current playlist anymore (since Sonos Version 4.2 the old playlist will be restored).
  - `SeparateStereoPair`
    Divides the stereo-pair into two independant devices.
  - `SnapshotGroupVolume`
    Save the current volume-relation of all players of the same group. It's neccessary for the use of "GroupVolume" and is stored until the next call of "SnapshotGroupVolume".

#### Get

- Common
  - `Alarm <ID>`
    It's an exception to the normal getter semantics. Returns directly a Perl-Hash with the Alarm-Informations to the given id. It's just a shorthand for `eval(ReadingsVal(<Devicename>, 'Alarmlist', ()))->{<ID>};`.
  - `EthernetPortStatus <PortNumber>`
    Gets the Ethernet-Portstatus of the given Port. Can be 'Active' or 'Inactive'.
  - `PossibleRoomIcons`
    Retreives a list of all possible Roomiconnames for the use with "set RoomIcon".
  - `SupportLinks`
    Shows a list with direct links to the player-support-sites.
- Lists
  - `Favourites`
    Retrieves a list with the names of all sonos favourites. This getter retrieves the same list on all Zoneplayer. The format is a comma-separated list with quoted names of favourites. e.g. "Liste 1","Entry 2","Test"
  - `FavouritesWithCovers`
    Retrieves a list with the stringrepresentation of a perl-hash which can easily be converted with "eval". It consists of the names and coverlinks of all of the favourites stored in Sonos e.g. {'FV:2/22' => {'Cover' => 'urlzumcover', 'Title' => '1. Favorit'}}
  - `Playlists`
    Retrieves a list with the names of all saved queues (aka playlists). This getter retrieves the same list on all Zoneplayer. The format is a comma-separated list with quoted names of playlists. e.g. "Liste 1","Liste 2","Test"
  - `PlaylistsWithCovers`
    Retrieves a list with the stringrepresentation of a perl-hash which can easily be converted with "eval". It consists of the names and coverlinks of all of the playlists stored in Sonos e.g. {'SQ:14' => {'Cover' => 'urlzumcover', 'Title' => '1. Playlist'}}
  - `Radios`
    Retrieves a list with the names of all saved radiostations (favorites). This getter retrieves the same list on all Zoneplayer. The format is a comma-separated list with quoted names of radiostations. e.g. "Sender 1","Sender 2","Test"
  - `RadiosWithCovers`
    Retrieves a list with the stringrepresentation of a perl-hash which can easily be converted with "eval". It consists of the names and coverlinks of all of the radiofavourites stored in Sonos e.g. {'R:0/0/2' => {'Cover' => 'urlzumcover', 'Title' => '1. Radiosender'}}
  - `SearchlistCategories`
    Retrieves a list with the possible categories for the setter "LoadSearchlist". The Format is a comma-separated list with quoted names of categories.
- Informations on the current Title
  - `CurrentTrackPosition`
    Retrieves the current timeposition inside a title

#### Attributes

'''Attention'''
The attributes can only be used after a restart of fhem, because it must be initially transfered to the subprocess.

- Common
  - `disable <int>`
    One of (0,1). Disables the event-worker for this Sonosplayer.
  - `generateSomethingChangedEvent <int>`
    One of (0,1). 1 if a 'SomethingChanged'-Event should be generated. This event is thrown every time an event is generated. This is useful if you wants to be notified on every change with a single event.
  - `generateVolumeEvent <int>`
    One of (0,1). Enables an event generated at volumechanges if minVolume or maxVolume is set.
  - `generateVolumeSlider <int>`
    One of (0,1). Enables a slider for volumecontrol in detail view.
  - `getAlarms <int>`
    One of (0..1). Initializes a callback-method for Alarms. This included the information of the DailyIndexRefreshTime.
  - `volumeStep <int>`
    One of (0..100). Defines the stepwidth for subsequent calls of `VolumeU` and `VolumeD`.
- Information Generation
  - `generateInfoSummarize1 <string>`
    Generates the reading 'InfoSummarize1' with the given format. More Information on this in the examples-section.
  - `generateInfoSummarize2 <string>`
    Generates the reading 'InfoSummarize2' with the given format. More Information on this in the examples-section.
  - `generateInfoSummarize3 <string>`
    Generates the reading 'InfoSummarize3' with the given format. More Information on this in the examples-section.
  - `generateInfoSummarize4 <string>`
    Generates the reading 'InfoSummarize4' with the given format. More Information on this in the examples-section.
  - `stateVariable <string>`
    One of (TransportState,NumberOfTracks,Track,TrackURI,TrackDuration,Title,Artist,Album,OriginalTrackNumber,AlbumArtist,
    Sender,SenderCurrent,SenderInfo,StreamAudio,NormalAudio,AlbumArtURI,nextTrackDuration,nextTrackURI,nextAlbumArtURI,
    nextTitle,nextArtist,nextAlbum,nextAlbumArtist,nextOriginalTrackNumber,Volume,Mute,Shuffle,Repeat,RepeatOne,CrossfadeMode,Balance,
    HeadphoneConnected,SleepTimer,Presence,RoomName,SaveRoomName,PlayerType,Location,SoftwareRevision,SerialNum,InfoSummarize1,
    InfoSummarize2,InfoSummarize3,InfoSummarize4). Defines, which variable has to be copied to the content of the state-variable.
- Controloptions
  - `maxVolume <int>`
    One of (0..100). Define a maximal volume for this Zoneplayer
  - `minVolume <int>`
    One of (0..100). Define a minimal volume for this Zoneplayer
  - `maxVolumeHeadphone <int>`
    One of (0..100). Define a maximal volume for this Zoneplayer for use with headphones
  - `minVolumeHeadphone <int>`
    One of (0..100). Define a minimal volume for this Zoneplayer for use with headphones
  - `buttonEvents <Time:Pattern>[ <Time:Pattern> ...]`
    Defines that after pressing a specified sequence of buttons at the player an event has to be thrown. The definition itself is a tupel: the first part (before the colon) is the time in seconds, the second part (after the colon) is the button sequence of this event.
    The following button-shortcuts are possible:
    - M: The Mute-Button
    - H: The Headphone-Connector
    - U: Up-Button (Volume Up)
    - D: Down-Button (Volume Down)
    The event thrown is named `ButtonEvent`, the value is the defined button-sequence.
    E.G.: `2:MM`
    Here an event is defined, where in time of 2 seconds the Mute-Button has to be pressed 2 times. The created event is named `ButtonEvent` and has the value `MM`.

#### Examples / Tips

- Format of InfoSummarize:
  `infoSummarizeX := <NormalAudio>:summarizeElem:</NormalAudio> <StreamAudio>:summarizeElem:</StreamAudio>|:summarizeElem:`
  `:summarizeElem: := <:variable:[ prefix=":text:"][ suffix=":text:"][ instead=":text:"][ ifempty=":text:"]/[ emptyVal=":text:"]>`
  `:variable: := TransportState|NumberOfTracks|Track|TrackURI|TrackDuration|Title|Artist|Album|OriginalTrackNumber|AlbumArtist|
  Sender|SenderCurrent|SenderInfo|StreamAudio|NormalAudio|AlbumArtURI|nextTrackDuration|nextTrackURI|nextAlbumArtURI|
  nextTitle|nextArtist|nextAlbum|nextAlbumArtist|nextOriginalTrackNumber|Volume|Mute|Shuffle|Repeat|RepeatOne|CrossfadeMode|Balance|
  HeadphoneConnected|SleepTimer|Presence|RoomName|SaveRoomName|PlayerType|Location|SoftwareRevision|SerialNum|InfoSummarize1|
  InfoSummarize2|InfoSummarize3|InfoSummarize4`
  `:text: := [Any text without double-quotes]`

### SSCam

Using this Module you are able to operate cameras which are defined in Synology Surveillance Station (SVS).
At present the following functions are available:

- Start a Recording
- Stop a Recording (using command or automatically after the <RecordTime> period
- Trigger a Snapshot
- Deaktivate a Camera in Synology Surveillance Station
- Activate a Camera in Synology Surveillance Station
- Control of the exposure modes day, night and automatic
- switchover the motion detection by camera, by SVS or to deactivate
- control of motion detection parameters sensitivity, threshold, object size and percentage for release
- Retrieval of Camera Properties (also by Polling) as well as informations about the installed SVS-package
- Move to a predefined Preset-position (at PTZ-cameras)
- Start a predefined Patrol (at PTZ-cameras)
- Positioning of PTZ-cameras to absolute X/Y-coordinates
- continuous moving of PTZ-camera lense
- trigger of external events 1-10 (action rules in SVS)
- start and stop of camera livestreams
- fetch of livestream-Url's with key (login not needed in that case)
- playback of last recording

The recordings and snapshots will be stored in Synology Surveillance Station (SVS) and are managed like the other (normal) recordings / snapshots defined by Surveillance Station rules.
For example the recordings are stored for a defined time in Surveillance Station and will be deleted after that period.
If you like to discuss or help to improve this module please use FHEM-Forum with link:
49_SSCam: Fragen, Hinweise, Neuigkeiten und mehr rund um dieses Modul.
Prerequisites
This module uses the CPAN-module JSON. Please consider to install this package (Debian: libjson-perl).
SSCam is completely using the nonblocking functions of HttpUtils respectively HttpUtils_NonblockingGet.
In DSM respectively in Synology Surveillance Station an User has to be created. The login credentials are needed later when using a set-command to assign the login-data to a device.
Further informations could be find among Credentials.
Overview which Perl-modules SSCam is using:
JSON
Data::Dumper
MIME::Base64
Time::HiRes
HttpUtils (FHEM-module)
Define

`define <name> SSCAM <Cameraname in SVS> <ServerAddr> [Port]`
Defines a new camera device for SSCam. At first the devices have to be set up and operable in Synology Surveillance Station 7.0 and above.
The Modul SSCam ist based on functions of Synology Surveillance Station API.
Please refer the Web API Guide.
Currently only HTTP-protocol is supported to call Synology DS.
The parameters are in detail:

name: | the name of the new device to use in FHEM
Cameraname: | Cameraname as defined in Synology Surveillance Station, Spaces are not allowed in Cameraname !
ServerAddr: | IP-address of Synology Surveillance Station Host. Note: avoid using hostnames because of DNS-Calls are not unblocking in FHEM
Port: | optional - the port of synology surveillance station, if not set the default of 5000 (HTTP only) is used

Example:

          define CamCP SSCAM Carport 192.168.2.20 [5000]

When a new Camera is defined, as a start the recordingtime of 15 seconds will be assigned to the device.
Using the attribute "rectime" you can adapt the recordingtime for every camera individually.
The value of "0" for rectime will lead to an endless recording which has to be stopped by a "set <name> off" command.
Due to a Log-Entry with a hint to that circumstance will be written.
If the attribute "rectime" would be deleted again, the default-value for recording-time (15s) become active.
With command "set <name> on [rectime]" a temporary recordingtime is determinded which would overwrite the dafault-value of recordingtime
and the attribute "rectime" (if it is set) uniquely.
In that case the command "set <name> on 0" leads also to an endless recording as well.
If you have specified a pre-recording time in SVS it will be considered too.
Credentials
After a camera-device is defined, firstly it is needed to save the credentials. This will be done with command:

         set <name> credentials <username> <password>

The operator can, dependend on what functions are planned to execute, create an user in DSM respectively in Synology Surveillance Station as well.
If the user is member of admin-group, he has access to all module functions. Without this membership the user can only execute functions with lower need of rights.
The required minimum rights to execute functions are listed in a table further down.
Alternatively to DSM-user a user created in SVS can be used. Also in that case a user of type "manager" has the right to execute all functions,
whereat the access to particular cameras can be restricted by the privilege profile (please see help function in SVS for details).
As best practice it is proposed to create an user in DSM as well as in SVS too:

- DSM-User as member of admin group: unrestricted test of all module functions -> session: DSM
- SVS-User as Manager or observer: adjusted privilege profile -> session: SurveillanceStation

Using the Attribute "session" can be selected, if the session should be established to DSM or the SVS instead.
If the session will be established to DSM, SVS Web-API methods are available as well as further API methods of other API's what possibly needed for processing.
After device definition the default is "login to DSM", that means credentials with admin rights can be used to test all camera-functions firstly.
After this the credentials can be switched to a SVS-session with a restricted privilege profile as needed on dependency what module functions are want to be executed.
The following list shows the minimum rights what the particular module function needs.

- set ... on

session: ServeillanceStation - observer with enhanced privilege "manual recording"

- set ... off

session: ServeillanceStation - observer with enhanced privilege "manual recording"

- set ... snap

session: ServeillanceStation - observer

- set ... disable

session: ServeillanceStation - manager

- set ... enable

session: ServeillanceStation - manager

- set ... expmode

session: ServeillanceStation - manager

- set ... motdetsc

session: ServeillanceStation - manager

- set ... goPreset

session: ServeillanceStation - observer with privilege objective control of camera

- set ... runPatrol

session: ServeillanceStation - observer with privilege objective control of camera

- set ... goAbsPTZ

session: ServeillanceStation - observer with privilege objective control of camera

- set ... move

session: ServeillanceStation - observer with privilege objective control of camera

- set ... runView

session: ServeillanceStation - observer with privilege liveview of camera

- set ... extevent

session: DSM - user as member of admin-group

- set ... stopView

-

- set ... credentials

-

- get ... caminfoall

session: ServeillanceStation - observer

- get ... eventlist

session: ServeillanceStation - observer

- get ... svsinfo

session: ServeillanceStation - observer

- get ... snapfileinfo

session: ServeillanceStation - observer

- get ... stmUrlPath

session: ServeillanceStation - observer

HTTP-Timeout Settings
All functions of the SSCam-Module are using HTTP-Calls to the SVS Web API.
The Default-Value of the HTTP-Timeout amounts 4 seconds. You can set the Attribute "httptimeout" > 0 to adjust the value as needed in your technical environment.

Set

Currently there are the following options for "Set <name> ..." :

"on [rectime]": | starts a recording. The recording will be stopped automatically after a period of [rectime]
| if [rectime] = 0 an endless recording will be started
"off" : | stopps a running recording manually or using other events (e.g. with at, notify)
"snap": | triggers a snapshot of the relevant camera and store it into Synology Surveillance Station
"disable": | deactivates a camera in Synology Surveillance Station
"enable": | activates a camera in Synology Surveillance Station
"credentials <username> <password>": | save a set of credentils
"expmode [ day | night | auto ]": | set the exposure mode to day, night or auto
"extevent [ 1-10 ]": | triggers the external event 1-10 (see actionrule editor in SVS)
"motdetsc [ camera | SVS | disable ]": | set motion detection to the desired mode
"goPreset <Presetname>": | moves a PTZ-camera to a predefinied Preset-position
"runPatrol <Patrolname>": | starts a predefinied patrol (PTZ-cameras)
"goAbsPTZ [ X Y | up | down | left | right ]": | moves a PTZ-camera to a absolute X/Y-coordinate or to direction up/down/left/right
"move [ up | down | left | right | dir_X ]": | starts a continuous move of PTZ-camera to direction up/down/left/right or dir_X
"runView [image | lastrec | lastrec_open | link | link_open <room> ]": | starts a livestream as embedded image or link
"stopView": | stops a camera livestream

"set <name> [on] [off]"
The command "set <name> on" starts a recording. The default recording time takes 15 seconds. It can be changed by the attribute "rectime" individualy. With the attribute (respectively the default value) provided recording time can be overwritten once by "set <name> on [rectime]". The recording will be stopped after processing time "rectime"automatically.
A special case is the start using "set <name> on 0" respectively the attribute value "rectime = 0". In that case a endless-recording will be started. One have to stop this recording by command "set <name> off" explicitely.
The recording behavior can be impacted with attribute "recextend" furthermore as explained as follows.
Attribute "recextend = 0" or not set (default):

- if, for example, a recording with rectimeme=22 is started, no other startcommand (for a recording) will be accepted until this started recording is finished. A hint will be logged in case of verboselevel = 3.

Attribute "recextend = 1" is set:

- a before started recording will be extend by the recording time "rectime" if a new start command is received. That means, the timer for the automatic stop-command will be renewed to "rectime" given bei the command, attribute or default value. This procedure will be repeated every time a new start command for recording is received. Therefore a running recording will be extended until no start command will be get.
- a before started endless-recording will be stopped after recordingtime 2rectime" if a new "set <name> on"-command is received (new set of timer). If it is unwanted make sure you don't set the attribute "recextend" in case of endless-recordings.

Examples for simple Start/Stop a Recording:

set <name> on [rectime] | starts a recording of camera <name>, stops automatically after [rectime] (default 15s or defined by attribute)
set <name> off | stops the recording of camera <name>

"set <name> snap"
A snapshot can be triggered with:

         set <name> snap

Subsequent some Examples for taking snapshots:
If a serial of snapshots should be released, it can be done using the following notify command. For the example a serial of snapshots are to be triggerd if the recording of a camera starts.
When the recording of camera "CamHE1" starts (Attribut event-on-change-reading -> "Record" has to be set), then 3 snapshots at intervals of 2 seconds are triggered.

         define he1_snap_3 notify CamHE1:Record.*on define h3 at +*{3}00:00:02 set CamHE1 snap

Release of 2 Snapshots of camera "CamHE1" at intervals of 6 seconds after the motion sensor "MelderHE1" has sent an event,
can be done e.g. with following notify-command:

         define he1_snap_2 notify MelderHE1:on.* define h2 at +*{2}00:00:06 set CamHE1 snap

The ID and the filename of the last snapshot will be displayed as value of variable "LastSnapId" respectively "LastSnapFilename" in the device-Readings.
"set <name> [enable] [disable]"
For
deactivating / activating a list of cameras or all cameras using a Regex-expression, subsequent two examples using "at":

         define a13 at 21:46 set CamCP1,CamFL,CamHE1,CamTER disable (enable)
         define a14 at 21:46 set Cam.* disable (enable)

A bit more convenient is it to use a dummy-device for enable/disable all available cameras in Surveillance Station.
At first the Dummy will be created.

         define allcams dummy
         attr allcams eventMap on:enable off:disable
         attr allcams room Cams
         attr allcams webCmd enable:disable

With combination of two created notifies, respectively one for "enable" and one for "diasble", you are able to switch all cameras into "enable" or "disable" state at the same time if you set the dummy to "enable" or "disable".

         define all_cams_disable notify allcams:.*off set CamCP1,CamFL,CamHE1,CamTER disable
         attr all_cams_disable room Cams

         define all_cams_enable notify allcams:on set CamCP1,CamFL,CamHE1,CamTER enable
         attr all_cams_enable room Cams

"set <name> expmode [day] [night] [auto]"
With this command you are able to control the exposure mode and can set it to day, night or automatic mode. Thereby, for example, the behavior of camera LED's will be suitable controlled. The successful switch will be reported by the reading CamExposureMode (command "get ... caminfoall").
Hint:
The successfully execution of this function depends on if SVS supports that functionality of the connected camera. Is the field for the Day/Night-mode shown greyed in SVS -> IP-camera -> optimization -> exposure mode, this function will be probably unsupported.
"set <name> motdetsc [camera] [SVS] [disable]"
The command "motdetsc" (stands for "motion detection source") switchover the motion detection to the desired mode. If motion detection will be done by camera / SVS without any parameters, the original camera motion detection settings are kept. The successful execution of that opreration one can retrace by the state in SVS -> IP-camera -> event detection -> motion.
For the motion detection further parameter can be specified. The available options for motion detection by SVS are "sensitivity" and "threshold".

set <name> motdetsc SVS [sensitivity] [threshold] | # command pattern
set <name> motdetsc SVS 91 30 | # set the sensitivity to 91 and threshold to 30
set <name> motdetsc SVS 0 40 | # keep the old value of sensitivity, set threshold to 40
set <name> motdetsc SVS 15 | # set the sensitivity to 15, threshold keep unchanged

If the motion detection is used by camera, there are the options "sensitivity", "object size", "percentage for release" available.

set <name> motdetsc camera [sensitivity] [threshold] [percentage] | # command pattern
set <name> motdetsc camera 89 0 20 | # set the sensitivity to 89, percentage to 20
set <name> motdetsc camera 0 40 10 | # keep old value for sensitivity, set threshold to 40, percentage to 10
set <name> motdetsc camera 30 | # set the sensitivity to 30, other values keep unchanged

Please consider always the sequence of parameters. Unwanted options have to be set to "0" if further options which have to be changed are follow (see example above). The numerical values are between 1 - 99 (except special case "0").
The each available options are dependend of camera type respectively the supported functions by SVS. Only the options can be used they are available in SVS -> edit camera -> motion detection. Further informations please read in SVS online help.
With the command "get ... caminfoall" the Reading "CamMotDetSc" also will be updated which documents the current setup of motion detection. Only the parameters and parameter values supported by SVS at present will be shown. The camera itself may offer further options to adjust.
Example:

      CamMotDetSc    SVS, sensitivity: 76, threshold: 55

"set <name> goPreset <Preset>"
Using this command you can move PTZ-cameras to a predefined position.
The Preset-positions have to be defined first of all in the Synology Surveillance Station. This usually happens in the PTZ-control of IP-camera setup in SVS. The Presets will be read ito FHEM with command "get <name> caminfoall" (happens automatically when FHEM restarts). The import process can be repeated regular by camera polling. A long polling interval is recommendable in this case because of the Presets are only will be changed if the user change it in the IP-camera setup itself.
Here it is an example of a PTZ-control depended on IR-motiondetector event:

        define CamFL.Preset.Wandschrank notify MelderTER:on.* set CamFL goPreset Wandschrank, ;; define CamFL.Preset.record at +00:00:10 set CamFL on 5 ;;;; define s3 at +*{3}00:00:05 set CamFL snap ;; define CamFL.Preset.back at +00:00:30 set CamFL goPreset Home

Operating Mode:
The IR-motiondetector registers a motion. Hereupon the camera "CamFL" moves to Preset-posion "Wandschrank". A recording with the length of 5 seconds starts 10 seconds later. Because of the prerecording time of the camera is set to 10 seconds (cf. Reading "CamPreRecTime"), the effectice recording starts when the camera move begins.
When the recording starts 3 snapshots with an interval of 5 seconds will be taken as well.
After a time of 30 seconds in position "Wandschrank" the camera moves back to postion "Home".
An extract of the log illustrates the process:

       2016.02.04 15:02:14 2: CamFL - Camera Flur_Vorderhaus has moved to position "Wandschrank"
       2016.02.04 15:02:24 2: CamFL - Camera Flur_Vorderhaus Recording with Recordtime 5s started
       2016.02.04 15:02:29 2: CamFL - Snapshot of Camera Flur_Vorderhaus has been done successfully
       2016.02.04 15:02:30 2: CamFL - Camera Flur_Vorderhaus Recording stopped
       2016.02.04 15:02:34 2: CamFL - Snapshot of Camera Flur_Vorderhaus has been done successfully
       2016.02.04 15:02:39 2: CamFL - Snapshot of Camera Flur_Vorderhaus has been done successfully
       2016.02.04 15:02:44 2: CamFL - Camera Flur_Vorderhaus has moved to position "Home"

"set <name> runPatrol <Patrolname>"
This commans starts a predefined patrol (tour) of a PTZ-camera.
At first the patrol has to be predefined in the Synology Surveillance Station. It can be done in the PTZ-control of IP-Kamera Setup -> PTZ-control -> patrol. The patrol tours will be read with command "get <name> caminfoall" which is be executed automatically when FHEM restarts. The import process can be repeated regular by camera polling. A long polling interval is recommendable in this case because of the patrols are only will be changed if the user change it in the IP-camera setup itself. Further informations for creating patrols you can get in the online-help of Surveillance Station.
"set <name> goAbsPTZ [ X Y | up | down | left | right ]"
This command can be used to move a PTZ-camera to an arbitrary absolute X/Y-coordinate, or to absolute position using up/down/left/right. The option is only available for cameras which are having the Reading "CapPTZAbs=true". The property of a camera can be requested with "get <name> caminfoall" .
Example for a control to absolute X/Y-coordinates:

        set <name> goAbsPTZ 120 450

In this example the camera lense moves to position X=120 und Y=450.
The valuation is:

        X = 0 - 640      (0 - 319 moves lense left, 321 - 640 moves lense right, 320 don't move lense)
        Y = 0 - 480      (0 - 239 moves lense down, 241 - 480 moves lense up, 240 don't move lense)

The lense can be moved in smallest steps to very large steps into the desired direction. If necessary the procedure has to be repeated to bring the lense into the desired position.
If the motion should be done with the largest possible increment the following command can be used for simplification:

       set <name> goAbsPTZ up [down ] [left] [right]

In this case the lense will be moved with largest possible increment into the given absolute position. Also in this case the procedure has to be repeated to bring the lense into the desired position if necessary.
set <name> move [ up | down | left | right | dir_X ] [seconds]
With this command a continuous move of a PTZ-camera will be started. In addition to the four basic directions up/down/left/right is it possible to use angular dimensions "dir_X". The grain size of graduation depends on properties of the camera and can be identified by the Reading "CapPTZDirections".
The radian measure of 360 degrees will be devided by the value of "CapPTZDirections" and describes the move drections starting with "0=right" counterclockwise. That means, if a camera Reading is "CapPTZDirections = 8" it starts with dir_0 = right, dir_2 = top, dir_4 = left, dir_6 = bottom and respectively dir_1, dir_3, dir_5 and dir_7 the appropriate directions between. The possible moving directions of cameras with "CapPTZDirections = 32" are correspondingly divided into smaller sections.
In opposite to the "set <name> goAbsPTZ"-command starts "set <name> move" a continuous move until a stop-command will be received. The stop-command will be generated after the optional assignable time of [seconds]. If that retention period wouldn't be set by the command, a time of 1 second will be set implicit.
Examples:

        set <name> move up 0.5      : moves PTZ 0,5 Sek. (plus processing time) to the top
        set <name> move dir_1 1.5   : moves PTZ 1,5 Sek. (plus processing time) to top-right
        set <name> move dir_20 0.7  : moves PTZ 1,5 Sek. (plus processing time) to left-bottom ("CapPTZDirections = 32)"

set <name> runView [ image | lastrec | lastrec_open | link | link_open <room> ]
With "image, link, link_open" a livestream (mjpeg-stream) of a camera will be started, either as embedded image or as a generated link. Access to the last recording of a camera can be done using "lastrec" respectively "lastrec_open". The behavior of livestream in FHEMWEB can be affected by statements in attribute "htmlattr".
Examples:

        attr <name> htmlattr target=_blank width="500" height="375"
        attr <name> htmlattr target=_blank width=500,height=375
        attr <name> htmlattr width=700,height=525,top=200,left=300

With these attribute values a streaming link will be opened (by click on) in a new browser tab or windows. If the stream will be started as an image, the size changes appropriately the values of width and hight.
The command "set <name> runView link_open" starts the stream immediately in a new browser window (longpoll=1 must be set for WEB). A browser window will be initiated to open for every FHEM session which is active. If you want to change this, you can use command "set <name> runView link_open <room>" what initiates to open a browser window in that FHEM session that has just opend the room <room>. The settings of attribute "livestreamprefix" overwrites the data for protocol, servername and port in reading "LiveStreamUrl". By "livestreamprefix" the LivestreamURL (is shown if attribute "showStmInfoFull" is set) can be modified and used for distribution and external access to SVS livestream.
Example:

        attr <name> livestreamprefix https://<Servername>:<Port>

The livestream will be stopped again using command "set <name> stopView" .
set <name> extevent [ 1-10 ]
This command triggers an external event (1-10) in SVS. The actions which will are used have to be defined in the actionrule editor of SVS at first. There are the events 1-10 possible. In the message application of SVS you may select Email, SMS or Mobil (DS-Cam) messages to release if an external event has been triggerd. Further informations can be found in the online help of the actionrule editor. The used user needs to be a member of the admin-group and DSM-session is needed too.

Get

With SSCam the properties of SVS and defined Cameras could be retrieved. Actually it could be done by using the following commands:

          get <name> caminfoall
          get <name> eventlist
          get <name> stmUrlPath
          get <name> svsinfo
          get <name> snapfileinfo

With command "get <name> caminfoall" dependend of the type of Camera (e.g. Fix- or PTZ-Camera) the available properties will be retrieved and provided as Readings.
For example the Reading "Availability" will be set to "disconnected" if the Camera would be disconnected from Synology Surveillance Station and can be used for further processing like creating events.
By command "get <name> eventlist" the Reading "CamEventNum" and "CamLastRecord" will be refreshed which containes the total number of in SVS registered camera events and the path / name of the last recording. This command will be implicit executed when "get ... caminfoall" is running.
The attribute "videofolderMap" replaces the content of reading "VideoFolder". You can use it for example if you have mounted the videofolder of SVS under another name or path and want to access by your local pc. Using "get <name> snapfileinfo" the filename of the last snapshot will be retrieved. This command will be executed with "get <name> snap" automatically.
The command "get <name> svsinfo" is not really dependend on a camera, but rather a command to determine common informations about the installed SVS-version and other properties.
The functions "caminfoall" and "svsinfo" will be executed automatically once-only after FHEM restarts to collect some relevant informations for camera control.
Please consider to save the credentials what will be used for login to DSM or SVS !
get <name> stmUrlPath
This command is to fetch the streamkey information and streamurl using that streamkey. The reading "StmKey" will be filled when this command will be executed and can be used to send it and run by your own application like a browser (see example). If the attribute "showStmInfoFull" is set, additional stream readings like "StmKeyUnicst", "StmKeymjpegHttp" will be shown and can be used to run the appropriate livestream without session id. Is the attribute "livestreamprefix" (usage: "http(s)://<hostname><port>) used, the servername / port will be replaced if necessary. The strUrlPath function will be included automatically if polling is used.
Example to create an http-call to a livestream using the StmKey:

         http(s)://<hostname><port>/webapi/entry.cgi?api=SYNO.SurveillanceStation.VideoStreaming&version=1&method=Stream&format=mjpeg&cameraId=5&StmKey="31fd87279976d89bb98409728cced890"

cameraId (INTERNAL), StmKey has to be replaced by valid values.
Hint:
If you use the stream-call from external and replace hostname / port with valid values and open your router ip ports, please make shure that no unauthorized person could get this sensible data !
Polling of Camera-Properties:
Retrieval of Camera-Properties can be done automatically if the attribute "pollcaminfoall" will be set to a value > 10.
As default that attribute "pollcaminfoall" isn't be set and the automatic polling isn't be active.
The value of that attribute determines the interval of property-retrieval in seconds. If that attribute isn't be set or < 10 the automatic polling won't be started
respectively stopped when the value was set to > 10 before.
The attribute "pollcaminfoall" is monitored by a watchdog-timer. Changes of the attribute-value will be checked every 90 seconds and transact corresponding.
Changes of the pollingstate and pollinginterval will be reported in FHEM-Logfile. The reporting can be switched off by setting the attribute "pollnologging=1".
Thereby the needless growing of the logfile can be avoided. But if verbose level is set to 4 or above even though the attribute "pollnologging" is set as well, the polling
will be actived due to analysis purposes.
If FHEM will be restarted, the first data retrieval will be done within 60 seconds after start.
The state of automatic polling will be displayed by reading "PollState":

- PollState = Active - automatic polling will be executed with interval correspondig value of attribute "pollcaminfoall"
- PollState = Inactive - automatic polling won't be executed

The meaning of reading values is described under Readings .
Notes:
If polling is used, the interval should be adjusted only as short as needed due to the detected camera values are predominantly static.
A feasible guide value for attribute "pollcaminfoall" could be between 600 - 1800 (s).
Per polling call and camera approximately 10 - 20 Http-calls will are stepped against Surveillance Station.
Because of that if HTTP-Timeout (pls. refer Attribut "httptimeout") is set to 4 seconds, the theoretical processing time couldn't be higher than 80 seconds.
Considering a safety margin, in that example you shouldn't set the polling interval lower than 160 seconds.
If several Cameras are defined in SSCam, attribute "pollcaminfoall" of every Cameras shouldn't be set exactly to the same value to avoid processing bottlenecks
and thereby caused potential source of errors during request Synology Surveillance Station.
A marginal difference between the polling intervals of the defined cameras, e.g. 1 second, can already be faced as sufficient value.

Internals

The meaning of used Internals is depicted in following list:

- CAMID - the ID of camera defined in SVS, the value will be retrieved automatically on the basis of SVS-cameraname
- CAMNAME - the name of the camera in SVS
- CREDENTIALS - the value is "Set" if Credentials are set
- NAME - the cameraname in FHEM
- OPMODE - the last executed operation of the module
- SERVERADDR - IP-Address of SVS Host
- SERVERPORT - SVS-Port

Readings

Using the polling mechanism or retrieval by "get"-call readings are provieded, The meaning of the readings are listed in subsequent table:
The transfered Readings can be deversified dependend on the type of camera.

- Availability

- Availability of Camera (disabled, enabled, disconnected, other)

- CamEventNum

- delivers the total number of in SVS registered events of the camera

- CamExposureControl

- indicating type of exposure control

- CamExposureMode

- current exposure mode (Day, Night, Auto, Schedule, Unknown)

- CamForceEnableMulticast

- Is the camera forced to enable multicast.

- CamIP

- IP-Address of Camera

- CamLastRec

- Path / name of the last recording

- CamLastRecTime

- date / starttime / endtime of the last recording

- CamLiveMode

- Source of Live-View (DS, Camera)

- CamModel

- Model of camera

- CamMotDetSc

- state of motion detection source (disabled, by camera, by SVS) and their parameter

- CamPort

- IP-Port of Camera

- CamPreRecTime

- Duration of Pre-Recording (in seconds) adjusted in SVS

- CamRecShare

- shared folder on disk station for recordings

- CamRecVolume

- Volume on disk station for recordings

- CamVendor

- Identifier of camera producer

- CamVideoFlip

- Is the video flip

- CamVideoMirror

- Is the video mirror

- CapAudioOut

- Capability to Audio Out over Surveillance Station (false/true)

- CapChangeSpeed

- Capability to various motion speed

- CapPTZAbs

- Capability to perform absolute PTZ action

- CapPTZAutoFocus

- Capability to perform auto focus action

- CapPTZDirections

- the PTZ directions that camera support

- CapPTZFocus

- mode of support for focus action

- CapPTZHome

- Capability to perform home action

- CapPTZIris

- mode of support for iris action

- CapPTZPan

- Capability to perform pan action

- CapPTZTilt

- mode of support for tilt action

- CapPTZZoom

- Capability to perform zoom action

- DeviceType

- device type (Camera, Video_Server, PTZ, Fisheye)

- Error

- message text of last error

- Errorcode

- error code of last error

- LastSnapFilename

- the filename of the last snapshot

- LastSnapId

- the ID of the last snapshot

- LastUpdateTime

- date / time the last update of readings by "caminfoall"

- LiveStreamUrl

- the livestream URL if stream is started (is shown if attribute "showStmInfoFull" is set)

- Patrols

- in Synology Surveillance Station predefined patrols (at PTZ-Cameras)

- PollState

- shows the state of automatic polling

- Presets

- in Synology Surveillance Station predefined Presets (at PTZ-Cameras)

- Record

- if recording is running = Start, if no recording is running = Stop

- StmKey

- current streamkey. it can be used to open livestreams without session id

- StmKeyUnicst

- Uni-cast stream path of the camera. (attribute "showStmInfoFull" has to be set)

- StmKeymjpegHttp

- Mjpeg stream path(over http) of the camera (attribute "showStmInfoFull" has to be set)

- SVScustomPortHttp

- Customized port of Surveillance Station (HTTP) (to get with "svsinfo")

- SVScustomPortHttps

- Customized port of Surveillance Station (HTTPS) (to get with "svsinfo")

- SVSlicenseNumber

- The total number of installed licenses (to get with "svsinfo")

- SVSuserPriv

- The effective rights of the user used for log in (to get with "svsinfo")

- SVSversion

- package version of the installed Surveillance Station (to get with "svsinfo")

- UsedSpaceMB

- used disk space of recordings by Camera

- VideoFolder

- Path to the recorded video

Attributes

- debugactivetoken - if set the state of active token will be logged - only for debugging, don't use it in normal operation !
- disable - deactivates the module (device definition)
- httptimeout - Timeout-Value of HTTP-Calls to Synology Surveillance Station, Default: 4 seconds (if httptimeout = "0" or not set)
- htmlattr - additional specifications to livestream-Url to manipulate the behavior of stream, e.g. size of the image
- livestreamprefix - overwrites the specifications of protocol, servername and port for further use of the livestream address, e.g. as an link to external use. It has to be specified as "http(s)://<servername>:<port>"
- noQuotesForSID - this attribute may be helpfull in some cases to avoid errormessage "402 - permission denied" and makes login possible.
- pollcaminfoall - Interval of automatic polling the Camera properties (if < 10: no polling, if > 10: polling with interval)
- pollnologging - "0" resp. not set = Logging device polling active (default), "1" = Logging device polling inactive
- rectime - the determined recordtime when a recording starts. If rectime = 0 an endless recording will be started. If it isn't defined, the default recordtime of 15s is activated
- recextend - "rectime" of a started recording will be set new. Thereby the recording time of the running recording will be extended
- session - selection of login-Session. Not set or set to "DSM" -> session will be established to DSM (Sdefault). "SurveillanceStation" -> session will be established to SVS
- simu_SVSversion - simulates another SVS version. (only a lower version than the installed one is possible !)
- showStmInfoFull - additional stream informations like LiveStreamUrl, StmKeyUnicst, StmKeymjpegHttp will be created
- showPassInLog - if set the used password will be shown in logfile with verbose 4. (default = 0)
- videofolderMap - replaces the content of reading "VideoFolder", Usage if e.g. folders are mountet with different names than original (SVS)
- verbose

Different Verbose-Level are supported.
Those are in detail:

0 | - Start/Stop-Event will be logged
1 | - Error messages will be logged
2 | - messages according to important events were logged
3 | - sended commands will be logged
4 | - sended and received informations will be logged
5 | - all outputs will be logged for error-analyses. Caution: a lot of data could be written into logfile !

further Attributes:
- readingFnAttributes

### STACKABLE_CC

This module handles the stackable CC1101 devices for the Raspberry PI from busware.de. You can attach a lot of CUL-Type devices to a single RPi this way. The first device is defined as a CUL, the rest of them as STACKABLE_CC.
Define

`define <name> STACKABLE_CC <Base-Device-Name>`
<Base-Device-Name> is the name of the device, which this device is attached on, the first one has to be defined as a CUL device
Example:

`define SCC0 CUL /dev/ttyAMA0@38400
attr SCC0 rfmode SlowRF
define SCC1 STACKABLE_CC SCC0
attr SCC1 rfmode HomeMatic
define SCC2 STACKABLE_CC SCC1
attr SCC2 rfmode Max
`

Important:

- The rfmode has to be specified explicitely (valid for the STACKABLE_CC types only, not for the first, which is defined as a CUL).
- In case of SlowRF, the FHTID has to be specified explicitely with the command "set SCCX raw T01HHHH". Again, this is valid for the STACKABLE_CC types only.
- If you rename the base CUL or a STACKABLE_CC, which is a base for another one, the define of the next one has to be adjusted, and FHEM has to be restarted.

Set

Same as for the CUL.

Get

Same as for the CUL.

Attributes

- IODev
- ignore
The rest of the attributes is the same as for the CUL.

### STOCKQUOTES

(en | de)

Fetching actual stock quotes from various sources
Preliminary
Perl module Finance::Quote must be installed:
`cpan install Finance::Quote` or `sudo apt-get install libfinance-quote-perl`
Define

`define Depot STOCKQUOTES`

Set

<Symbol> depends on source. May also an WKN.
- `set <name> buy <Symbol> <Amount> <Value of amount>`
  Add a stock exchange security. If stock exchange security already exists, new values will be added to old values.
- `set <name> sell <Symbol> <Amount> <Value of amount>`
  Remove a stock exchange security (or an part of it).
- `set <name> add <Symbol>`
  Watch only
- `set <name> remove <Symbol>`
  Remove watched stock exchange security.
- `set <name> clearReadings`
  Clears all readings.
- `set <name> update`
  Refresh all readings.

Get

- `get <name> sources`
  Lists all avaiable data sources.
- `get <name> currency <Symbol>`
  Get currency of stock exchange securities

Attributes

- currency
  All stock exchange securities will shown in this currency.
  Default: EUR
- defaultSource
  Default source for stock exchange securities values.
  Default: europe, valid values: from `get <name> sources`
- queryTimeout
  Fetching timeout in seconds.
  Standard: 120, valid values: Number
- pollInterval
  Refresh interval in seconds.
  Standard: 300, valid values: Number
- sources
  An individual data source can be set for every single stock exchange securities.
  Data sources can be fetched with: `get <name> sources`.
  Format: <Symbol>:<Source>[,<Symbol>:<Source>...]
  Example: `A0M16S:vwd,532669:unionfunds,849104:unionfunds`
  Stock exchange securities not listed in sources will be updated from defaultSource.
- stocks
  Will be created/modified via buy/sell/add/remove
  Contains stock exchange securities informations in format: <Symbol>:<Anzahl>:<Einstandswert>[,<Symbol>:<Anzahl>:<Einstandswert>...]

### STV

This module supports Samsung TV devices.
LEXXBXX (B Series) use port 52235
LEXXCXX (C|D Series) use port 55000

Define
`define <name> STV <host>]`

Example:
define Television1 STV 192.168.178.20
or define Television2 STV 192.168.178.20 52235
define Television2 STV 192.168.178.20 55000

Set
set <name> <value> <nummber>
where value is one of:

- `mute`
- `volume`
- `call`
- `sms`
- `date`

Example:
set <name> mute
set <name> volume 20
set <name> call Peter 012345678 Phone 87654321
Get

N/A

### SUNRISE_EL

This module is used to define the functions

    sunrise, sunset,
    sunrise_rel, sunset_rel
    sunrise_abs, sunset_abs
    isday

perl functions, to be used in at or FS20 on-till commands.
First you should set the longitude and latitude global attributes to the exact longitude and latitude values (see e.g. maps.google.com for the exact values, which should be in the form of a floating point value). The default value is Frankfurt am Main, Germany.
The default altitude ($defaultaltit in SUNRISE_EL.pm) defines the sunrise/sunset for Civil twilight (i.e. one can no longer read outside without artificial illumination), which differs from sunrise/sunset times found on different websites. See perldoc "DateTime::Event::Sunrise" for alternatives.
sunrise()/sunset() returns the absolute time of the next sunrise/sunset, adding 24 hours if the next event is tomorrow, to use it in the timespec of an at device or for the on-till command for FS20 devices.
sunrise_rel()/sunset_rel() returns the relative time to the next sunrise/sunset.
sunrise_abs()/sunset_abs() return the absolute time of the corresponding event today (no 24 hours added).
sunrise_abs_dat()/sunset_abs_dat() return the absolute time of the corresponding event to a given date(no 24 hours added).
All functions take up to three arguments:

- The first specifies an offset (in seconds), which will be added to the event.
- The second and third specify min and max values (format: "HH:MM").

isday() can be used in some notify or at commands to check if the sun is up or down. isday() ignores the seconds parameter, but respects min and max. If min < max, than the day starts not before min, and ends not after max. If min > max, than the day starts not after max, and ends not before min.
Optionally, for all functions you can set first argument which defines a horizon value which then is used instead of the $defaultaltit in SUNRISE_EL.pm.
Possible values are: "REAL", "CIVIL", "NAUTIC", "ASTRONOMIC" or a positive or negative number preceded by "HORIZON="
REAL is 0, CIVIL is -6, NATUIC is -12, ASTRONOMIC is -18 degrees above horizon.
Examples:

        # When sun is 6 degrees below horizon - same as sunrise();
        sunrise("CIVIL");

        # When sun is 3 degrees below horizon (between real and civil sunset)
        sunset("HORIZON=-3");

        # When sun is 1 degree above horizon
        sunset("HORIZON=1");

        # Switch lamp1 on at real sunset, not before 18:00 and not after 21:00
        define a15 at *{sunset("REAL",0,"18:00","21:00")} set lamp1 on

The functions sunrise_abs_dat()/sunset_abs_dat() need as a very first parameter the date(format epoch: time()) for which the events should be calculated.
Examples:

        # to calculate the sunrise of today + 7 days
        my $date = time() + 7*86400;
        sunrise_abs_dat($date);

        # to calculate the sunrise of today + 7 days 6 degrees below horizon
        my $date = time() + 7*86400;
        sunrise_abs_dat($date, "CIVIL");

Define

N/A

Set

N/A

Get

N/A

Attributes

- latitude
  If set, this latitude is used to calculate sunset/sunrise
  Notation need to be in decimal format (for example Berlin = 52.666) As default Frankfurt/Main, Germany (50.112) is used.
- longitude
  If set, this longitude is used to calculate sunset/sunrise
  Notation need to be in decimal format (for example Berlin = 13.400) As default Frankfurt/Main, Germany (8.686) is used.
- altitude
  Used by other modules.
Note: these are global attributes, e.g.

attr global latitude 50.112
attr global longitude 8.686

### SVG

Define

`define <name> SVG <logDevice>:<gplotfile>:<logfile>`
This is the Plotting/Charting device of FHEMWEB Examples:

`define MyPlot SVG inlog:temp4hum4:CURRENT`

Notes:

- Normally you won't define an SVG device manually, as FHEMWEB makes it easy for you, just plot a logfile (see logtype) and click on "Create SVG instance". Specifying CURRENT as a logfilename will always access the current logfile, even if its name changes regularly.
- For historic reasons this module uses a Gnuplot file description to store different attributes. Some special commands (beginning with #FileLog or #DbLog) are used additionally, and not all gnuplot attribtues are implemented.

Set

- copyGplotFile
  Copy the currently specified gplot file to a new file, which is named after the SVG device, existing files will be overwritten. This operation is needed in order to use the plot editor (see below) without affecting other SVG instances using the same gplot file. Creating the SVG instance from the FileLog detail menu will also create a unique gplot file, in this case this operation is not needed.

Get

N/A

Attributes

- fixedrange [offset]
  Contains two time specs in the form YYYY-MM-DD separated by a space. In plotmode gnuplot-scroll(-svg) or SVG the given time-range will be used, and no scrolling for this SVG will be possible. Needed e.g. for looking at last-years data without scrolling.
  If the value is one of hour, day, <N>days, week, month, year than set the zoom level for this SVG independently of the user specified zoom-level. This is useful for pages with multiple plots: one of the plots is best viewed in with the default (day) zoom, the other one with a week zoom.
  If given, the optional integer parameter offset refers to a different period (e.g. last year: fixedrange year -1, 2 days ago: fixedrange day -2).
- fixedoffset <nDays>
  Set an fixed offset (in days) for the plot.
- startDate
  Set the start date for the plot. Used for demo installations.
- plotsize
- plotmode
- endPlotNow
- endPlotToday
- plotWeekStartDay
- label
  Double-Colon separated list of values. The values will be used to replace <L#> type of strings in the .gplot file, with # beginning at 1 (<L1>, <L2>, etc.). Each value will be evaluated as a perl expression, so you have access e.g. to the Value functions.
  If the plotmode is gnuplot-scroll(-svg) or SVG, you can also use the min, max, mindate, maxdate, avg, cnt, sum, firstval, firstdate, currval (last value) and currdate (last date) values of the individual curves, by accessing the corresponding values from the data hash, see the example below:
  - Fixed text for the right and left axis:
    - Fhem config:
      attr wl_1 label "Temperature"::"Humidity"
    - .gplot file entry:
      set ylabel <L1>
      set y2label <L2>
  - Title with maximum and current values of the 1st curve (FileLog)
    - Fhem config:
      attr wl_1 label "Max $data{max1}, Current $data{currval1}"
    - .gplot file entry:
      set title <L1>
  The value minAll and maxAll (representing the minimum/maximum over all values) is also available from the data hash.
- title
  A special form of label (see above), which replaces the string <TL> in the .gplot file. It defaults to the filename of the logfile.
- captionLeft
  Show the legend on the left side.
- plotfunction
  Space value separated list of values. The value will be used to replace <SPEC#> type of strings in the .gplot file, with # beginning at 1 (<SPEC1>, <SPEC2>, etc.) in the #FileLog or #DbLog directive. With this attribute you can use the same .gplot file for multiple devices with the same logdevice.
  Example:
  - #FileLog <SPEC1>
    with: attr <SVGdevice> plotfunction "4:IR\x3a:0:"
    instead of
    #FileLog 4:IR\x3a:0:
  - #DbLog <SPEC1>
    with: attr <SVGdevice> plotfunction "Garage_Raumtemp:temperature::"
    instead of
    #DbLog Garage_Raumtemp:temperature::

Plot-Editor
This editor is visible on the detail screen of the SVG instance. Most features are obvious here, up to some exceptions:

- if you want to omit the title for a Diagram label, enter notitle in the input field.
- if you want to specify a fixed value (not taken from a column) if a string found (e.g. 1 if the FS20 switch is on and 0 if it is off), then you have to specify the Tics first, and write the .gplot file, before you can select this value from the dropdown.
  Example:
  Enter in the Tics field: ("On" 1, "Off" 0)
  Write .gplot file
  Select "1" from the column dropdown (note the double quote!) for the regexp switch.on, and "0" for the regexp switch.off.
  Write .gplot file again
- If the range is of the form {...}, then it will be evaluated with perl. The result is a string, and must have the form [min:max]

The visibility of the ploteditor can be configured with the FHEMWEB attribute ploteditor.

### SWAP

The SWAP protocoll is used by panStamps (panstamp.com).
This is a generic module that will handle all SWAP devices with known device description files via a panStick as the IODevice.
All communication is done on the SWAP register level. FHEM readings are created for all user registers and userReadings are created to map low level SWAP registers to 'human readable' format with the mapping from the device descriprion files.
For higher level features like "on,off,on-for-timer,..." specialized modules have to be used.
Messages for devices in power-down-state are queued and send when the device enters SYNC state. This typicaly happens during device startup after a reset.
Notes:

- This module requires XML::Simple.
- Devices with the default address FF will be changed to the first free address in the range F0-FE.
- For power-down devices the default transmit interval of FFFF will be changed to 0384 (900 seconds).

Define

`define <name> SWAP <ID>`
The ID is a 2 digit hex number to identify the moth in the panStamp network.

Set

- regGet <reg>
  request status message for register id <reg>. for system registers the register name can be used instead if the two digit register id in hex.
- regSet <reg> <data>
  write <data> to register id <reg>. for system registers the register name can be used instead if the twi digit register id in hex.
- regSet <reg>.<ep> <data>
  write <data> to endpoint <ep> of register <reg>. will not work if no reading for register <reg> is available as all nibbles that are not part of endpoint <ep> will be filled from this reading.
- statusRequest
  request transmision of all registers.
- readDeviceXML
  reload the device description xml file.
- clearUnconfirmed
  clears the list of unconfirmed messages.
- flash [<productCode>|<firmwareFile>]
  will initiate an ota firmware update. only possible for panStamp NRG devices.
  no params -> will use the `SWAP_<current productCode>.hex` file from the FHEM/firmware directory.
  <productCode> -> will use the `SWAP_<productCode>.hex` file from the FHEM/firmware directory.
  <firmwareFile> -> will use <firmwareFile> as the absolute file name of the hex file.

Get

- regList
  list all non-system registers of this device.
- regListAll
  list all registers of this device.
- listUnconfirmed
  list all unconfirmed messages.
- products
  dumps all known devices.
- deviceXML
  dumps the device xml data.

Attributes

- createUnknownReadings
  Create readings for unknown registers, i.e. registers not defined in the device xml file.
- ProductCode
  ProductCode of the device. used to read the register configuration from the device definition file. hast to be set manualy for devices that are in sleep mode during definition.

### SWAP_0000002200000003

Module for the justme version of the panstamp rgb driver board with ir (sketch product code 0000002200000003).
to learn an ir command the simplest way ist to use 'learnIR #'. the on board led will start to blink indicating ir learning mode. after an ir command is received the blinking will switch to slow and the boards waits for a fhem command (on/off/...) and will link the ir command to the fhem command.
received ir commands that will not trigger one of the 16 possible learned commands will be send as SWAP register 0C to fhem and can be used in notifys.
SWAP register 0E will configure the power on state of the board: off, configured color, last color before power down.
Define

`define <name> SWAP_0000002200000003 <ID> 0000002200000003`

Set all SWAP set commands and:

- on
- on-for-timer <time>
- off
- toggle
- rgb <RRGGBB>
  set the led color
- dimUP
- dimDown
- setIR # <code>
- learnIR #
- storeIR # <code> <command>
- getIR # | all
  read content of IR regisgter # or all IR registers
- setFade <RRGGBB> <time>
  stores color and time in fede register #
- startFade <#1> <#2>
  starts an endless fading loop over all fading registers [#1..#2]
- getFade # | all
  read content of fade regisgter # or all fade regisgters
- set extensions are supported.

Get all SWAP get commands and:

- rgb
  returns the current led color
- listIR
  list all IR registers of this device. use getIR first.
- listFade
  list all fade registers. use getFade first.

Attributes

- color-icon
  1 -> use lamp color as icon color and 100% shape as icon shape
  2 -> use lamp color scaled to full brightness as icon color and dim state as icon shape
- ProductCode
  must be 0000002200000003

### SWAP_0000002200000008

Module for the justme version of the panstamp indoor multi sensor board (sketch product code 0000002200000008).
Define

`define <name> SWAP_0000002200000008 <ID> 0000002200000008`

Set all SWAP set commands and:

- desired <value>
  sets the desired temperature to <value>
- text <text>
  displays text

Get all SWAP get commands and:

Attributes

- ProductCode
  must be 0000002200000008

### SYSMON

(en | de)

This module provides statistics about the system running FHEM server. Furthermore, remote systems can be accessed (Telnet). Only Linux-based systems are supported. Some informations are hardware specific and are not available on every platform. So far, this module has been tested on the following systems: Raspberry Pi (Debian Wheezy), BeagleBone Black, FritzBox 7390, WR703N under OpenWrt, CubieTruck and some others.
For more information on a FritzBox check other moduls: FRITZBOX and FB_CALLMONITOR.
The modul uses the Perl modul 'Net::Telnet' for remote access. Please make sure that this module is installed.
Define
`define <name> SYSMON [MODE[:[USER@]HOST][:PORT]] [<M1>[ <M2>[ <M3>[ <M4>]]]]`
This statement creates a new SYSMON instance. The parameters M1 to M4 define the refresh interval for various Readings (statistics). The parameters are to be understood as multipliers for the time defined by INTERVAL_BASE. Because this time is fixed at 60 seconds, the Mx-parameter can be considered as time intervals in minutes.
If one (or more) of the multiplier is set to zero, the corresponding readings is deactivated.
The parameters are responsible for updating the readings according to the following scheme:

- M1: (Default: 1)
  cpu_freq, cpu_temp, cpu_temp_avg, loadavg, stat_cpu, stat_cpu_diff, stat_cpu_percent, stat_cpu_text, power readings
- M2: (Default: M1)
  ram, swap
- M3: (Default: M1)
  eth0, eth0_diff, wlan0, wlan0_diff
- M4: (Default: 10*M1)
  Filesystem informations
- The following parameters are always updated with the base interval (regardless of the Mx-parameter):
  fhemuptime, fhemuptime_text, idletime, idletime_text, uptime, uptime_text, starttime, starttime_text

To query a remote system at least the address (HOST) must be specified. Accompanied by the port and / or user name, if necessary. The password (if needed) has to be defined once with the command 'set password <password>'. For MODE parameter are 'telnet' and 'local' only allowed. 'local' does not require any other parameters and can also be omitted.
Readings:

- cpu_core_count
  CPU core count
- cpu_model_name
  CPU model name
- cpu_bogomips
  CPU Speed: BogoMIPS
- cpu_freq (and cpu1_freq for dual core systems)
  CPU frequency
- cpu_temp
  CPU temperature
- cpu_temp_avg
  Average of the CPU temperature, formed over the last 4 values.
- fhemuptime
  Time (in seconds) since the start of FHEM server.
- fhemuptime_text
  Time since the start of the FHEM server: human-readable output (text representation).
- fhemstarttime
  Start time (in seconds since 1.1.1970 1:00:00) of FHEM server.
- fhemstarttime_text
  Start time of the FHEM server: human-readable output (text representation).
- idletime
  Time spent by the system since the start in the idle mode (period of inactivity).
- idletime_text
  The inactivity time of the system since system start in human readable form.
- loadavg
  System load (load average): 1 minute, 5 minutes and 15 minutes.
- ram
  memory usage.
- swap
  swap usage.
- uptime
  System uptime.
- uptime_text
  System uptime (human readable).
- starttime
  System starttime.
- starttime_text
  System starttime (human readable).
- Network statistics
  Statistics for the specified network interface about the data volumes transferred and the difference since the previous measurement.
  Examples:
  Amount of the transmitted data via interface eth0.
  `eth0: RX: 940.58 MB, TX: 736.19 MB, Total: 1676.77 MB`
  Change of the amount of the transferred data in relation to the previous call (for eth0).
  `eth0_diff: RX: 0.66 MB, TX: 0.06 MB, Total: 0.72 MB`
  IP and IP v6 adresses `eth0_ip 192.168.0.15`
  `eth0_ip6 fe85::49:4ff:fe85:f885/64`
- Network Speed (if avialable)
  speed of the network connection.
  Examples:
  `eth0_speed 100`
- File system information
  Usage of the desired file systems.
  Example:
  `fs_root: Total: 7340 MB, Used: 3573 MB, 52 %, Available: 3425 MB at /`
- CPU utilization
  Information about the utilization of CPUs.
  Example:
  `stat_cpu: 10145283 0 2187286 90586051 542691 69393 400342`
  `stat_cpu_diff: 2151 0 1239 2522 10 3 761`
  `stat_cpu_percent: 4.82 0.00 1.81 93.11 0.05 0.00 0.20`
  `stat_cpu_text: user: 32.17 %, nice: 0.00 %, sys: 18.53 %, idle: 37.72 %, io: 0.15 %, irq: 0.04 %, sirq: 11.38 %`
- user defined
  These readings provide output of commands, which are passed to the operating system or delivered by user defined functions.
FritzBox specific Readings
- wlan_state
  WLAN state: on/off
- wlan_guest_state
  GuestWLAN state: on/off
- internet_ip
  current IP-Adresse
- internet_state
  state of the Internet connection: connected/disconnected
- night_time_ctrl
  state night time control (do not disturb): on/off
- num_new_messages
  Number of new Voice Mail messages
- fw_version_info
  Information on the installed firmware version: <VersionNum> <creation date> <time>
DSL Informations (FritzBox)
- dsl_rate
  Information about the down und up stream rate
- dsl_synctime
  sync time with DSLAM
- dsl_crc_15
  number of uncorrectable errors (CRC) for the last 15 minutes
- dsl_fec_15
  number of correctable errors (FEC) for the last 15 minutes
Power Supply Readings
- power_ac_stat
  status information to the AC socket: online (0|1), present (0|1), voltage, current
  Example:
  `power_ac_stat: 1 1 4.807 264`
- power_ac_text
  human readable status information to the AC socket
  Example:
  `power_ac_text ac: present / online, voltage: 4.807 V, current: 264 mA`
- power_usb_stat
  status information to the USB socket
- power_usb_text
  human readable status information to the USB socket
- power_battery_stat
  status information to the battery (if installed): online (0|1), present (0|1), voltage, current, actual capacity
  Example:
  `power_battery_stat: 1 1 4.807 264 100`
- power_battery_text
  human readable status information to the battery (if installed)
- power_battery_info
  human readable additional information to the battery (if installed): technology, capacity, status, health, total capacity
  Example:
  `power_battery_info: battery info: Li-Ion , capacity: 100 %, status: Full , health: Good , total capacity: 2100 mAh`
  The capacity must be defined in script.bin (e.g. ct-hdmi.bin). Parameter name pmu_battery_cap. Convert with bin2fex (bin2fex -> script.fex -> edit -> fex2bin -> script.bin).
- cpuX_freq_stat
  Frequency statistics for CPU X: minimum, maximum and average values
  Example:
  `cpu0_freq_stat: 100 1000 900`
- cpuX_idle_stat
  Idle statistik for CPU X: minimum, maximum and average values
  Example:
  `cpu0_freq_stat: 23.76 94.74 90.75`
- cpu[X]_temp_stat
  Temperature statistik for CPU: minimum, maximum and average values
  Example:
  `cpu_temp_stat: 41.00 42.50 42.00`
- ram_used_stat
  RAM usage statistics: minimum, maximum and average values
  Example:
  `ram_used_stat: 267.55 1267.75 855.00`
- swap_used_stat
  SWAP usage statistics: minimum, maximum and average values
  Example:
  `swap_used_stat: 0 1024.00 250.00`

Get:

- interval_base
  Lists the specified polling intervalls.
- interval_multipliers
  Displays update intervals.
- list
  Lists all readings.
- update
  Refreshs all readings.
- version
  Displays the version of SYSMON module.
- list_lan_devices
  Displays known LAN Devices (FritzBox only).

Set:

- interval_multipliers
  Defines update intervals (as in the definition of the device).
- clean
  Clears user-definable Readings. After an update (manual or automatic) new readings are generated.
- clear <reading name>
  Deletes the Reading entry with the given name. After an update this entry is possibly re-created (if defined). This mechanism allows the selective deleting unnecessary custom entries.
- password <Passwort>
  Specify the password for remote access (usually only necessary once).

Attributes:

- filesystems <reading name>[:<mountpoint>[:<comment>]],...
  Specifies the file system to be monitored (a comma-separated list).
  Reading-name is used in the display and logging, the mount point is the basis of the evaluation, comment is relevant to the HTML display (see SYSMON_ShowValuesHTML)
  Examples:
  `/boot,/,/media/usb1`
  `fs_boot:/boot,fs_root:/:Root,fs_usb1:/media/usb1:USB-Stick`
- network-interfaces <name>[:<interface>[:<comment>]],...
  Comma-separated list of network interfaces that are to be monitored. Each entry consists of the Reading-name, the name of the Netwerk adapter and a comment for the HTML output (see SYSMON_ShowValuesHTML). If no colon is used, the value is used simultaneously as a Reading-name and interface name.
  Example `ethernet:eth0:Ethernet,wlan:wlan0:WiFi`
- user-defined <readingsName>:<Interval_Minutes>:<Comment>:<Cmd>,...
  This comma-separated list defines user defined Readings with the following data: Reading name, refresh interval (in minutes), a Comment, and operating system command.
  The os commands are executed according to the specified Intervals and are noted as Readings with the specified name. Comments are used for the HTML output (see SYSMON_ShowValuesHTML)..
  All parameter parts are required!
  It is important that the specified commands are executed quickly, because at this time the entire FHEM server is blocked!
  If results of the long-running operations required, these should be set up as a CRON job and store results as a text file.
  Example: Display of package updates for the operating system:
  cron-Job:
  `sudo apt-get update 2>/dev/null >/dev/null` `apt-get upgrade --dry-run| perl -ne '/(\d*)\s[upgraded|aktualisiert]\D*(\d*)\D*install|^ \S+.*/ and print "$1 aktualisierte, $2 neue Pakete"' 2>/dev/null > /opt/fhem/data/updatestatus.txt`
  `uder-defined` attribute
  `sys_updates:1440:System Aktualisierungen:cat /opt/fhem/data/updatestatus.txt`
  the number of available updates is daily recorded as 'sys_updates'.
- user-fn <fn_name>:<interval_minutes>:<reading_name1>:<reading_name2>...[:<reading_nameX>], ...
  List of perl user subroutines.
  As <fn_name> can be used either the name of a Perl subroutine or a Perl expression. The perl function gets the device hash as parameter and must provide an array of values. These values are taken according to the parameter <reading_nameX> in Readings.
  A Perl expression must be enclosed in curly braces and can use the following parameters: $ HASH (device hash) and $ NAME (device name). Return is expected analogous to a Perl subroutine.
  Important! The separation between multiple user functions must be done with a comma AND a space! Within the function definition commas may not be followed by spaces.
- disable
  Possible values: 0 and 1. '1' means that the update is stopped.
- telnet-prompt-regx, telnet-login-prompt-regx
  RegExp to detect login and command line prompt. (Only for access via Telnet.)
- exclude
  Allows to suppress reading certain information.
  supported values: user-defined (s. user-defined und user-fn), cpucount, uptime, fhemuptime, loadavg, cputemp, cpufreq, cpuinfo, diskstat, cpustat, ramswap, filesystem, network, fbwlan, fbnightctrl, fbnewmessages, fbdecttemp, fbversion, fbdsl, powerinfo

Plots:

predefined gplot files:

FileLog versions:
`SM_RAM.gplot
SM_CPUTemp.gplot
SM_FS_root.gplot
SM_FS_usb1.gplot
SM_Load.gplot
SM_Network_eth0.gplot
SM_Network_eth0t.gplot
SM_Network_wlan0.gplot
SM_CPUStat.gplot
SM_CPUStatSum.gplot
SM_CPUStatTotal.gplot
SM_power_ac.gplot
SM_power_usb.gplot
SM_power_battery.gplot
` DbLog versions:
`SM_DB_all.gplot
SM_DB_CPUFreq.gplot
SM_DB_CPUTemp.gplot
SM_DB_Load.gplot
SM_DB_Network_eth0.gplot
SM_DB_RAM.gplot
`

HTML output method (see Weblink): SYSMON_ShowValuesHTML(<SYSMON-Instance>[,<Liste>])

The module provides a function that returns selected Readings as HTML.
As a parameter the name of the defined SYSMON device is expected.
It can also Reading Group, Clone dummy or other modules be used. Their readings are simple used for display.
The second parameter is optional and specifies a list of readings to be displayed in the format `<ReadingName>[:<Comment>[:<Postfix>[:<FormatString>]]]`.
`ReadingName` is the Name of desired Reading, `Comment` is used as the display name and postfix is displayed after the value (such as units or as MHz can be displayed). If FormatString is specified, the output is formatted with sprintf (s. sprintf in Perl documentation).
If no `Comment` is specified, an internally predefined description is used.
If no list specified, a predefined selection is used (all values are displayed).
`define sysv1 weblink htmlCode {SYSMON_ShowValuesHTML('sysmon')}`
`define sysv2 weblink htmlCode {SYSMON_ShowValuesHTML('sysmon', ('date:Datum', 'cpu_temp:CPU Temperatur: °C:%.1f'', 'cpu_freq:CPU Frequenz: MHz'))}`

Text output method (see Weblink): SYSMON_ShowValuesHTMLTitled(<SYSMON-Instance>[,<Title>,<Liste>])

According to SYSMON_ShowValuesHTML, but with a Title text above. If no title provided, device alias will be used (if any)

Text output method (see Weblink): SYSMON_ShowValuesText(<SYSMON-Instance>[,<Liste>])

According to SYSMON_ShowValuesHTML, but formatted as plain text.

Text output method (see Weblink): SYSMON_ShowValuesTextTitled(<SYSMON-Instance>[,<Title>,<Liste>])

According to SYSMON_ShowValuesHTMLTitled, but formatted as plain text.

Reading values with perl: SYSMON_getValues(<name>[, <array of desired keys>])

Returns a hash ref with desired values. If no array is passed, all values are returned.
{(SYSMON_getValues("sysmon"))->{'cpu_temp'}}
{(SYSMON_getValues("sysmon",("cpu_freq","cpu_temp")))->{"cpu_temp"}}
{join(" ", values (SYSMON_getValues("sysmon")))}
{join(" ", values (SYSMON_getValues("sysmon",("cpu_freq","cpu_temp"))))}

Examples:

`# Modul-Definition
define sysmon SYSMON 1 1 1 10
#attr sysmon event-on-update-reading cpu_temp,cpu_temp_avg,cpu_freq,eth0_diff,loadavg,ram,^~ /.*usb.*,~ /$
attr sysmon event-on-update-reading cpu_temp,cpu_temp_avg,cpu_freq,eth0_diff,loadavg,ram,fs_.*,stat_cpu_percent
attr sysmon filesystems fs_boot:/boot,fs_root:/:Root,fs_usb1:/media/usb1:USB-Stick
attr sysmon network-interfaces eth0:eth0:Ethernet,wlan0:wlan0:WiFi
attr sysmon group RPi
attr sysmon room 9.03_Tech
# Log
define FileLog_sysmon FileLog ./log/sysmon-%Y-%m.log sysmon
attr FileLog_sysmon group RPi
attr FileLog_sysmon logtype SM_CPUTemp:Plot,text
attr FileLog_sysmon room 9.03_Tech
# Visualisierung: CPU-Temperatur
define wl_sysmon_temp SVG FileLog_sysmon:SM_CPUTemp:CURRENT
attr wl_sysmon_temp group RPi
attr wl_sysmon_temp label "CPU Temperatur: Min $data{min2}, Max $data{max2}, Last $data{currval2}"
attr wl_sysmon_temp room 9.03_Tech
# Visualisierung: Netzwerk-Datenübertragung für eth0
define wl_sysmon_eth0 SVG FileLog_sysmon:SM_Network_eth0:CURRENT
attr wl_sysmon_eth0 group RPi
attr wl_sysmon_eth0 label "Netzwerk-Traffic eth0: $data{min1}, Max: $data{max1}, Aktuell: $data{currval1}"
attr wl_sysmon_eth0 room 9.03_Tech
# Visualisierung: Netzwerk-Datenübertragung für wlan0
define wl_sysmon_wlan0 SVG FileLog_sysmon:SM_Network_wlan0:CURRENT
attr wl_sysmon_wlan0 group RPi
attr wl_sysmon_wlan0 label "Netzwerk-Traffic wlan0: $data{min1}, Max: $data{max1}, Aktuell: $data{currval1}"
attr wl_sysmon_wlan0 room 9.03_Tech
# Visualisierung: CPU-Auslastung (load average)
define wl_sysmon_load SVG FileLog_sysmon:SM_Load:CURRENT
attr wl_sysmon_load group RPi
attr wl_sysmon_load label "Load Min: $data{min1}, Max: $data{max1}, Aktuell: $data{currval1}"
attr wl_sysmon_load room 9.03_Tech
# Visualisierung: RAM-Nutzung
define wl_sysmon_ram SVG FileLog_sysmon:SM_RAM:CURRENT
attr wl_sysmon_ram group RPi
attr wl_sysmon_ram label "RAM-Nutzung Total: $data{max1}, Min: $data{min2}, Max: $data{max2}, Aktuell: $data{currval2}"
attr wl_sysmon_ram room 9.03_Tech
# Visualisierung: Dateisystem: Root-Partition
define wl_sysmon_fs_root SVG FileLog_sysmon:SM_FS_root:CURRENT
attr wl_sysmon_fs_root group RPi
attr wl_sysmon_fs_root label "Root Partition Total: $data{max1}, Min: $data{min2}, Max: $data{max2}, Aktuell: $data{currval2}"
attr wl_sysmon_fs_root room 9.03_Tech
# Visualisierung: Dateisystem: USB-Stick
define wl_sysmon_fs_usb1 SVG FileLog_sysmon:SM_FS_usb1:CURRENT
attr wl_sysmon_fs_usb1 group RPi
attr wl_sysmon_fs_usb1 label "USB1 Total: $data{max1}, Min: $data{min2}, Max: $data{max2}, Aktuell: $data{currval2}"
attr wl_sysmon_fs_usb1 room 9.03_Tech
# Anzeige der Readings zum Einbinden in ein 'Raum'.
define SysValues weblink htmlCode {SYSMON_ShowValuesHTML('sysmon')}
attr SysValues group RPi
attr SysValues room 9.03_Tech
# Anzeige CPU Auslasung
define wl_sysmon_cpustat SVG FileLog_sysmon:SM_CPUStat:CURRENT
attr wl_sysmon_cpustat label "CPU(min/max): user:$data{min1}/$data{max1} nice:$data{min2}/$data{max2} sys:$data{min3}/$data{max3} idle:$data{min4}/$data{max4} io:$data{min5}/$data{max5} irq:$data{min6}/$data{max6} sirq:$data{min7}/$data{max7}"
attr wl_sysmon_cpustat group RPi
attr wl_sysmon_cpustat room 9.99_Test
attr wl_sysmon_cpustat plotsize 840,420
define wl_sysmon_cpustat_s SVG FileLog_sysmon:SM_CPUStatSum:CURRENT
attr wl_sysmon_cpustat_s label "CPU(min/max): user:$data{min1}/$data{max1} nice:$data{min2}/$data{max2} sys:$data{min3}/$data{max3} idle:$data{min4}/$data{max4} io:$data{min5}/$data{max5} irq:$data{min6}/$data{max6} sirq:$data{min7}/$data{max7}"
attr wl_sysmon_cpustat_s group RPi
attr wl_sysmon_cpustat_s room 9.99_Test
attr wl_sysmon_cpustat_s plotsize 840,420
define wl_sysmon_cpustatT SVG FileLog_sysmon:SM_CPUStatTotal:CURRENT
attr wl_sysmon_cpustatT label "CPU-Auslastung"
attr wl_sysmon_cpustatT group RPi
attr wl_sysmon_cpustatT plotsize 840,420
attr wl_sysmon_cpustatT room 9.99_Test
# Anzeige Stromversorgung AC
define wl_sysmon_power_ac SVG FileLog_sysmon:SM_power_ac:CURRENT
attr wl_sysmon_power_ac label "Stromversorgung (ac) Spannung: $data{min1} - $data{max1} V, Strom: $data{min2} - $data{max2} mA"
attr wl_sysmon_power_ac room Technik
attr wl_sysmon_power_ac group system
# Anzeige Stromversorgung Battery
define wl_sysmon_power_bat SVG FileLog_sysmon:SM_power_battery:CURRENT
attr wl_sysmon_power_bat label "Stromversorgung (bat) Spannung: $data{min1} - $data{max1} V, Strom: $data{min2} - $data{max2} mA"
attr wl_sysmon_power_bat room Technik
attr wl_sysmon_power_bat group system
`

### SYSSTAT

Provides system statistics for the host FHEM runs on or a remote Linux system that is reachable by preconfigured passwordless ssh access.
Notes:

- This module needs `Sys::Statistics::Linux` on Linux.
  It can be installed with '`cpan install Sys::Statistics::Linux`'
  or on debian with '`apt-get install libsys-statistics-linux-perl`'
- To monitor a target by snmp `Net::SNMP` hast to be installed.
- To plot the load values the following code can be used:

        define sysstatlog FileLog /usr/local/FHEM/var/log/sysstat-%Y-%m.log sysstat
        attr sysstatlog nrarchive 1
        define svg_sysstat SVG sysstatlog:sysstat:CURRENT
        attr wl_sysstat label "Load Min: $data{min1}, Max: $data{max1}, Aktuell: $data{currval1}"
        attr wl_sysstat room System

- to match the root filesystem (mount point '/') in diskusage plots use '`#FileLog 4:/\x3a:0:`' or '`#FileLog 4:\s..\s:0:`' and not '`#FileLog 4:/:0:`' as the later will match all mount points
.

Define

`define <name> SYSSTAT [<interval> [<interval_fs>] [<host>]]`
Defines a SYSSTAT device.
The load is updated every <interval> seconds. The default and minimum is 60.
The diskusage is updated every <interval_fs> seconds. The default is <interval>*60 and the minimum is 60. <interval_fs> is only aproximated and works best if <interval_fs> is an integral multiple of <interval>.
If <host> is given it has to be accessible by ssh without the need for a password. Examples:

`define sysstat SYSSTAT`
`define sysstat SYSSTAT 300`
`define sysstat SYSSTAT 60 600`

Readings

- load
  the 1 minute load average (for windows targets monitored by snmp aproximated value
- state
  the 1, 5 and 15 minute load averages (or windows targets monitored by snmp the per cpu utilization)
- user,system,idle,iowait
  respective percentage of systemutilization (linux targets only)
- <mountpoint>
  free bytes for <mountpoint>

Get

`get <name> <value>`
where `value` is one of
- filesystems
  Lists the filesystems that can be monitored.

Attributes

- disable
  keep timers running but disable collection of statistics.
- filesystems
  List of comma separated filesystems (not mountpoints) that should be monitored.
  Examples:
  `attr sysstat filesystems /dev/md0,/dev/md2`
  `attr sysstat filesystems /dev/.*`
  `attr sysstat filesystems 1,3,5`
</lu>
- disabledForIntervals HH:MM-HH:MM HH:MM-HH-MM...
- mibs
  space separated list of <mib>:<reding> pairs that sould be polled.
- showpercent
  If set the usage is shown in percent. If not set the remaining free space in bytes is shown.
- snmp
  1 -> use snmp to monitor load, uptime and filesystems (including physical and virtual memory)
- stat
  1 -> monitor user,system,idle and iowait percentage of system utilization (available only for linux targets)
- raspberrytemperature
  If set and > 0 the raspberry pi on chip termal sensor is read.
  If set to 2 a geometric average over the last 4 values is created.
- synologytemperature
  If set and > 0 the main temperaure of a synology diskstation is read. requires snmp.
  If set to 2 a geometric average over the last 4 values is created.
- raspberrycpufreq
  If set and > 0 the raspberry pi on chip termal sensor is read.
- uptime
  If set and > 0 the system uptime is read.
  If set to 2 the uptime is displayed in seconds.
- useregex
  If set the entries of the filesystems list are treated as regex.
- ssh_user
  The username for ssh remote access.
- snmpVersion
- snmpCommunity
- readingFnAttributes

### Snapcast

Snapcast is a module to control a Snapcast Server. Snapcast is a little project to achieve multiroom audio and is a leightweight alternative to such solutions using Pulseaudio. Find all information about Snapcast, how to install and configure on the Snapcast GIT. To use this module, the minimum is to define a snapcast server module which defines the connection to the actual snapcast server. See the define section for how to do this. On top of that, it is possible to define virtual client modules, so that each snapcast client that is connected to the Snapcast Server is represented by its own FHEM module. The purpose of that is to provide an interface to the user that enables to integrate Snapcast Clients into existing visualization solutions and to use other FHEM capabilities around it, e.g. Notifies, etc. The server module includes all readings of all snapcast clients, and it allows to control all functions of all snapcast clients. Each virtual client module just gets the reading for the specific client. The client modules is encouraged and also makes it possible to do per-client Attribute settings, e.g. volume step size and volume constraints.
Define

`define <name> Snapcast [<ip> <port>]`
Example: `define MySnap Snapcast 127.0.0.1 1705`
This way a snapcast server module is defined. IP defaults to localhost, and Port to 1705, in case you run Snapcast in the default configuration on the same server as FHEM, you dont need to give those parameters.
`define <name> Snapcast client <server> <clientid>`
Example: `define MySnapClient Snapcast client MySnap aabbccddeeff`
This way a snapcast client module is defined. The keyword client does this. The next argument links the client module to the associated server module. The final argument is the client ID. In Snapcast each client gets a unique ID, which is normally made out of the MAC address. Once the server module is initialized it will have all the client IDs in the readings, so you want to use those for the definition of the client modules

Set

For a Server module: `set <name> <function> <client> <value>`
For a Client module: `set <name> <function> <value>`
Options:

- update
  Perform a full update of the Snapcast Status including streams and servers. Only needed if something is not working. Server module only
- volume
  Set the volume of a client. For this and all the following 4 options, give client as second parameter (only for the server module), either as name, IP , or MAC and the desired value as third parameter. Client can be given as "all", in that case all clients are changed at once (only for server module)
  Volume can be given in 3 ways: Range betwee 0 and 100 to set volume directly. Increment or Decrement given between -100 and +100. Keywords up and down to increase or decrease with a predifined step size. The step size can be defined in the attribute volumeStepSize
  The step size can be defined smaller for the lower volume range, so that finetuning is possible in this area. See the description of the attributes volumeStepSizeSmall and volumeStepThreshold Setting a volume bigger than 0 also unmutes the client, if muted.
- mute
  Mute or unmute by giving "true" or "false" as value. If no argument given, toggle between muted and unmuted.
- latency
  Change the Latency Setting of the client
- name
  Change the Name of the client
- stream
  Change the stream that the client is listening to. Snapcast uses one or more streams which can be unterstood as virtual audio channels. Each client/room can subscribe to one of them. By using next as value, you can cycle through the avaialble streams

Attributes

All attributes can be set to the master module and the client modules. Using them for client modules enable the setting of different attribute values per client.
- streamnext
  Can be set to all or playing. If set to all, the next function cycles through all streams, if set to playing, the next function cycles only through streams in the playing state.
- volumeStepSize
  Default: 5. Set this to define, how far the volume is changed when using up/down volume commands.
- volumeStepThreshold
  Default: 7. When the volume is below this threshold, then the volumeStepSizeSmall setting is used for volume steps, rather than the normal volumeStepSize.
- volumeStepSizeSmall
  Default: 1. This typically smaller step size is used when using "volume up" or "volume down" and the current volume is smaller than the threshold.
- constraintDummy
  Links the Snapcast module to a dummy. The value of the dummy is then used as a selector for different sets of volumeConstraints. See the description of the volumeConstraint command.
- constraints
  Defines a set of volume Constraints for each client and, optionally, based on the value of the dummy as defined with constraintDummy. This way there can be different volume profiles for e.g. weekdays or weekends. volumeConstraints mean, that the maximum volume of snapcast clients can be limited or even set to 0 during certain times, e.g. at night for the childrens room, etc. the constraint argument is given in the folling format: <constraintSet>|hh:mm vol hh:mm vol ... [<constraintSet2>|hh:mm vol ... etc. The chain off <volume> pairs defines a volume profile for 24 hours. It is equivalent to the temeratore setting of the homematic thermostates supported by FHEM.
  Example: standard|08:00 0 18:00 100 22:00 30 24:00 0,weekend|10:00 0 20:00 100 24:00 30
In this example, there are two profiles defined. If the value of the associated dummy is "standard", then the standard profile is used. It mutes the client between midnight and 8 am, then allows full volume until 18:00, then limites the volume to 30 until 22:00 and then mutes the client for the rest of the day. The snapcast module does not increase the volume when a limited time is over, it only allows for increasing it manually again.

### TCM

The TCM module serves an USB or TCP/IP connected TCM 120 or TCM 310x, TCM 410J EnOcean Transceiver module. These are mostly packaged together with a serial to USB chip and an antenna, e.g. the BSC BOR contains the TCM 120, the USB 300 from EnOcean and the EUL from busware contains a TCM 310. See also the datasheet available from www.enocean.com.
As the TCM 120 and the TCM 310, TCM 410J speak completely different protocols, this module implements 2 drivers in one. It is the "physical" part for the EnOcean module.
Please note that EnOcean repeaters also send Fhem data telegrams again. Use `attr <name> blockSenderID own` to block receiving telegrams with TCM SenderIDs.
The address range used by your transceiver module, can be found in the parameters BaseID and LastID.
The transceiver moduls do not always support all commands. The supported range of commands depends on the hardware and the firmware version. A firmware update is usually not provided.
The TCM module enables also a wired connection to Eltako actuators over the Eltako RS485 bus in the switchboard or distribution box via Eltako FGW14 RS232-RS485 gateway modules. These actuators are linked to an associated wireless antenna module (FAM14) on the bus. The FAM14 device frequently polls the actuator status of all associated devices if the FAM14 operating mode rotary switch is on position 4. Therefore, actuator states can be retrieved more reliable, even after any fhem downtime, when switch events or actuator confirmations could not have been tracked during the downtime. As all actuators are polled approx. every 1-2 seconds, it should be avoided to use event-on-update-reading. Use instead either event-on-change-reading or event-min-interval. The Eltako bus uses the EnOcean Serial Protocol version 2 (ESP2). For this reason, a FGW14 can be configured as a ESP2. The attribute comType must be set to RS485.
Define

`define <name> TCM [ESP2|ESP3] <device>`
First you have to specify the type of the EnOcean Transceiver Chip, i.e either ESP2 for the TCM 120 or ESP3 for the TCM 310x, TCM 410J, USB 300, USB400J.
`device` can take the same parameters (@baudrate, @directio, TCP/IP, none) like the CUL, but you probably have to specify the baudrate: the TCM 120 should be opened with 9600 Baud, the TCM 310 with 57600 baud. For Eltako FGW14 devices, type has to be set to 120 and the baudrate has to be set to 57600 baud if the FGW14 operating mode rotary switch is on position 6.
Example:

`define BscBor TCM ESP2 /dev/ttyACM0@9600
define FGW14 TCM ESP2 /dev/ttyS3@57600
define TCM310 TCM ESP3 /dev/ttyACM0@57600
define TCM310 TCM ESP3 COM1@57600 (Windows)
`

Set

ESP2 (TCM 120)
- baseID [FF800000 ... FFFFFF80]
  Set the BaseID.
  Note: The firmware executes this command only up to then times to prevent misuse.
- modem_off
  Deactivates TCM modem functionality
- modem_on [0000 ... FFFF]
  Activates TCM modem functionality and sets the modem ID
- teach <t/s>
  Set Fhem in learning mode, see learningMode.
  The command is always required for UTE and to teach-in bidirectional actuators e. g. EEP 4BS (RORG A5-20-XX), see Teach-In / Teach-Out.
- reset
  Reset the device
- sensitivity [00|01]
  Set the TCM radio sensitivity: low = 00, high = 01
- sleep
  Enter the energy saving mode
- wake
  Wakes up from sleep mode
For details see the TCM 120 User Manual available from www.enocean.com.

ESP3 (TCM 310x, TCM 410J, USB 300, USB400J)
- baseID [FF800000 ... FFFFFF80]
  Set the BaseID.
  Note: The firmware executes this command only up to then times to prevent misuse.
- baudrate [00|01|02|03]
  Modifies the baud rate of the EnOcean device.
  baudrate = 00: 56700 baud (default)
  baudrate = 01: 115200 baud
  baudrate = 02: 230400 baud
  baudrate = 03: 460800 baud
- bist
  Perform Flash BIST operation (Built-in-self-test).
- filterAdd <FilterType><FilterValue><FilterKind>
  Add filter to filter list. Description of the filter parameters and examples, see EnOcean Serial Protocol 3 (ESP3)
- filterDel <FilterType><FilterValue>
  Del filter from filter list. Description of the filter parameters, see EnOcean Serial Protocol 3 (ESP3)
- filterDelAll
  Del all filter from filter list.
- filterEnable <FilterON/OFF><FilterOperator>
  Enable/Disable all supplied filters. Description of the filter parameters, see EnOcean Serial Protocol 3 (ESP3)
- init
  Initialize serial communication and transceiver configuration
- maturity [00|01]
  Waiting till end of maturity time before received radio telegrams will transmit: radio telegrams are send immediately = 00, after the maturity time is elapsed = 01
- mode [00|01]
  mode = 00: Compatible mode - ERP1 - gateway uses Packet Type 1 to transmit and receive radio telegrams
  mode = 01: Advanced mode - ERP2 - gateway uses Packet Type 10 to transmit and receive radio telegrams (for FSK products with advanced protocol)
- smartAckLearn <t/s>
  Set Fhem in 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.
  `t/s` is the time for the learning period.
- smartAckMailboxMax 0..20
  Enable the post master fuctionality and set amount of mailboxes available, 0 = disable post master functionality. Maximum 28 mailboxes can be created. This upper limit is for each firmware restricted and may be smaller.
- teach <t/s>
  Set Fhem in learning mode for RBS, 1BS, 4BS, GP, STE and UTE teach-in / teach-out, see learningMode.
  The command is always required for STE, GB, UTE and to teach-in bidirectional actuators e. g. EEP 4BS (RORG A5-20-XX)
- reset
  Reset the device
- repeater [0000|0101|0102]
  Set Repeater Level: off = 0000, 1 = 0101, 2 = 0102.
- sleep <t/10 ms> (Range: 00000000 ... 00FFFFFF)
  Enter the energy saving mode
- subtel [00|01]
  Transmitting additional subtelegram info: Enable = 01, Disable = 00
For details see the EnOcean Serial Protocol 3 (ESP3) available from www.enocean.com.

Get

TCM 120
- baseID
  Get the BaseID. You need this command in order to control EnOcean devices, see the EnOcean paragraph.
- modem_status
  Requests the current modem status.
- sensitivity
  Get the TCM radio sensitivity, low = 00, high = 01
- version
  Read the device SW version / HW version, chip-ID, etc.
For details see the TCM 120 User Manual available from www.enocean.com.

TCM 310
- baseID
  Get the BaseID. You need this command in order to control EnOcean devices, see the EnOcean paragraph.
- filter
  Get supplied filters. Description of the filter parameters, see EnOcean Serial Protocol 3 (ESP3)
- freqencyInfo
  Reads Frequency and protocol of the Device, see EnOcean Serial Protocol 3 (ESP3)
- numSecureDev
  Read number of teached in secure devices.
- repeater
  Read Repeater Level: off = 0000, 1 = 0101, 2 = 0102.
- smartAckLearnMode
  Get current smart ack learn mode
  Enable: 00|01 = off|on
  Extended: 00|01|02 = simple|advance|advanceSelectRep
- smartAckLearnedClients
  Get information about the learned smart ack clients
- stepCode
  Reads Hardware Step code and Revision of the Device, see EnOcean Serial Protocol 3 (ESP3)
- version
  Read the device SW version / HW version, chip-ID, etc.
For details see the EnOcean Serial Protocol 3 (ESP3) available from www.enocean.com.

Attributes

- blockSenderID <own|no>, [blockSenderID] = own is default.
  Block receiving telegrams with a TCM SenderID sent by repeaters.
- dummy
- baseID <FF800000 ... FFFFFF80>, [baseID] = <none> is default.
  Set Transceiver baseID and override automatic allocation. Use this attribute only if the IODev does not allow automatic allocation.
- comModeUTE <auto|biDir|uniDir>, [comModeUTE] = auto is default.
  Presetting the communication method of actuators that be taught using the UTE teach-in. The automatic selection of the communication method should only be overwrite manually, if this is explicitly required in the operating instructions of the actuator. The parameters should then be immediately re-set to "auto".
- comType <TCM|RS485>, [comType] = TCM is default.
  Type of communication device
- do_not_notify
- learningMode <always|demand|nearfield>, [learningMode] = demand is default.
  Learning method for automatic setup of EnOcean devices:
  [learningMode] = always: Teach-In/Teach-Out telegrams always accepted, with the exception of bidirectional devices
  [learningMode] = demand: Teach-In/Teach-Out telegrams accepted if Fhem is in learning mode, see also `set <IODev> teach <t/s>`
  [learningMode] = nearfield: Teach-In/Teach-Out telegrams accepted if Fhem is in learning mode and the signal strength RSSI >= -60 dBm.<be>
- sendInterval <0 ... 250>
  ESP2: [sendInterval] = 100 ms is default.
  ESP3: [sendInterval] = 0 ms is default.
  Smallest interval between two sending telegrams
- smartAckLearnMode <simple|advance|advanceSelectRep>
  select Smart Ack learn mode; only simple supported by Fhem
- smartAckMailboxMax <0 ... 28>
  Amount of mailboxes available, 0 = disable post master functionality. Maximum 28 mailboxes can be created. This upper limit is for each firmware restricted and may be smaller.
- verbose

Generated events

- baseID <transceiver response>
- maturity 00|01
- modem_status <transceiver response>
- numSecureDev <transceiver response>
- repeater 0000|0101|0102
- sensitivity 00|01
- version <transceiver response>
- state: opend|initialized

### TEK603

The TEK603 is a fhem module for the Tekelek TEK603 Eco Monitor a liquid level monitor designed for residential and small commercial applications. It works in conjunction with a TEK653 Sonic transmitter mounted on the top of the tank.
Prerequisites
The module requires the perl module Digest::CRC
On a debian based system the module can be installed with
`sudo apt-get install libdigest-crc-perl
`
Define

`define <name> TEK603 /dev/ttyUSBx`
Defines an TEK603 Eco Monitor device connected to USB.
Examples:

`define OelTank TEK603 /dev/ttyUSB0`

Readings

- Time
  TEK603 internal Time
- Temperature
  Sensor Temperature
- Ullage
  Sensor Measured Ullage
- RemainingUsableLevel
  This is the usable level, with deductions due to the sensor offset and outlet height. (Liters)
- RemainingUsablePercent
  This is the usable level in percent (calculated from RemainingUsableLevel and TotalUsableCapacity)
- TotalUsableCapacity
  This is the usable volume, with deductions due to the sensor offset and outlet height. (Liters)

### THINKINGCLEANER

This module provides support for ThinkingCleaner hardware add-on module for Roomba cleaning robots.
Define

`define <name> THINKINGCLEANER <IP-ADRESS or HOSTNAME>`
Example:

`define Robby THINKINGCLEANER 192.168.0.35`

Set

- cleaningDelay - sets cleaning delay in minutes when using on-delayed cleaning
- damageProtection - turns damage protection on or off while sending remotrControl commands (on/off)
- dock - Send Roomba back to it's docking station
- locate - Play sound to help finding Roomba
- off - Stop/pause cleaning
- on - Start cleaning
- on-delayed - Delayed start for cleaning according to cleaningDelay
- on-max - Start cleaning with max setting
- on-spot - Start spot cleaning
- power - Turn Roomba on or off (on/off)
- remoteControl - Send remote control commands
- scheduleAdd - Add new cleaning schedule
- scheduleDel - Delete existing cleaning schedule
- scheduleMod - Modify existing cleaning schedule
- statusRequest - Update device readings
- toggle - Toogle between on and off
- undock - Let Roomba leave it's docking station
- vacuumDrive - Enable or disable vaccuming during remoteControl commands (on/off)

Attributes

- pollInterval - Set regular polling interval in minutes (defaults to 45s)
- pollMultiplierCleaning - Change interval multiplier used during cleaning (defaults to 0.5)
- pollMultiplierWebhook - Change interval multiplier used during standby and webhook being enabled (defaults to 2)
- webhookFWinstance - Set FHEMWEB instance for incoming webhook events used by Roomba (mandatory for webhook)
- webhookHttpHostname - Set HTTP Hostname or IP address for incoming webhook events used by Roomba (mandatory for webhook)
- webhookPort - Use different port instead of what defined FHEMWEB instance uses (optional)

### THRESHOLD

Diverse controls can be realized by means of the module by evaluation of sensor data. In the simplest case, this module reads any sensor that provides values in decimal and execute FHEM/Perl commands, if the value of the sensor is higher or lower than the threshold value. A typical application is the simulation of a thermostat or humidistat.
With one or more such modules, complex systems can be implemented for heating, cooling, ventilation, dehumidification or shading. But even simple notification when crossing or falling below a specific value can be easily realized. It no if-statements in Perl or notify definitions need to be made. This leads to quickly create and clear controls, without having to necessarily go into the Perl matter.
Some application examples are at the end of the module description.
According to the definition of a module type THRESHOLD eg:
`define <name> THRESHOLD <sensor> <actor>`
It is controlled by setting a desired value with:
`set <name> desired <value>`
The module begins with the control system only when a desired value is set!
The specification of the desired value may also come from another sensor. This control may take place by the comparison of two sensors.
Likewise, any wall thermostats can be used (eg, HM, MAX, FHT) for the definition of the reference temperature.
The switching behavior can also be influenced by another sensor or sensor group.
The combination of multiple THRESHOLD modules together is possible, see examples below.

Define

`define <name> THRESHOLD <sensor>:<reading>:<hysteresis>:<target_value>:<offset> AND|OR <sensor2>:<reading2>:<state> <actor>|<cmd1_gt>|<cmd2_lt>|<cmd_default_index>|<state_cmd1_gt>:<state_cmd2_lt>|<state_format>`
- sensor
  a defined sensor in FHEM
- reading (optional)
  reading of the sensor, which includes a value in decimal
  default value: temperature
- hysteresis (optional)
  Hysteresis, this provides the threshold_min = desired_value - hysteresis
  default value: 1 at temperature, 10 at huminity
- target_value (optional)
  number: Initial value, if no value is specified, it must be set with "set desired value".
  else:<sensorname>:<reading>, an additional sensor can be specified, which sets the target value dynamically.
  default value: no value
- offset (optional)
  Offset to desired value
  This results:
  threshold_max = desired_value + offset and threshold_min = desired_value - hysteresis + offset
  Defaultwert: 0
- AND|OR (optional)
  logical operator with an optional second sensor
- sensor2 (optional, nur in Verbindung mit AND oder OR)
  the second sensor
- reading2 (optional)
  reading of the second sensor
  default value: state
- state (optional)
  state of the second sensor
  default value: open
- actor (optional)
  actor device defined in FHEM
- cmd1_gt (optional)
  FHEM/Perl command that is executed, if the value of the sensor is higher than desired value and/or the value of sensor 2 is matchted. @ is a placeholder for the specified actor.
  default value: set actor off, if actor defined
- cmd2_lt (optional)
  FHEM/Perl command that is executed, if the value of the sensor is lower than threshold_min or the value of sensor 2 is not matchted. @ is a placeholder for the specified actor.
  default value: set actor on, if actor defined
- cmd_default_index (optional)
  Index of command that is executed after setting the desired value until the desired value or threshold_min value is reached.
  0 - no command
  1 - cmd1_gt
  2 - cmd2_lt
  default value: 2, if actor defined, else 0
- state_cmd1_gt (optional, is defined as an attribute at the same time and can be changed there)
  state, which is displayed, if FHEM/Perl-command cmd1_gt was executed. If state_cmd1_gt state ist set, other states, such as active or deactivated are suppressed.
  default value: none
- state_cmd2_lt (optional, is defined as an attribute at the same time and can be changed there)
  state, which is displayed, if FHEM/Perl-command cmd1_gt was executed. If state_cmd1_gt state ist set, other states, such as active or deactivated are suppressed.
  default value: none
- state_format (optional, is defined as an attribute at the same time and can be changed there)
  Format of the state output: arbitrary text with placeholders.
  Possible placeholders:
  _m: mode
  _dv: desired_value
  _s1v: sensor_value
  _s2s: sensor2_state
  _sc: state_cmd
  Default value: _m _dv _sc, _sc when state_cmd1_gt and state_cmd2_lt set without actor.
Examples:
Example for heating:
It is heated up to the desired value of 20. If the value below the threshold_min value of 19 (20-1) the heating is switched on again.
`define thermostat THRESHOLD temp_sens heating`
`set thermostat desired 20`
Example for heating with window contact:
`define thermostat THRESHOLD temp_sens OR win_sens heating`
Example for heating with multiple window contacts:
`define W_ALL structure W_type W1 W2 W3 ....`
`attr W_ALL clientstate_behavior relative`
`attr W_ALL clientstate_priority open closed`
then:
`define thermostat THRESHOLD S1 OR W_ALL heating`
More examples for dehumidification, air conditioning, watering:
`define hygrostat THRESHOLD hym_sens:humidity dehydrator|set @ on|set @ off|1`
`define hygrostat THRESHOLD hym_sens:humidity AND Sensor2:state:close dehydrator|set @ on|set @ off|1`
`define thermostat THRESHOLD temp_sens:temperature:1 aircon|set @ on|set @ off|1`
`define thermostat THRESHOLD temp_sens AND Sensor2:state:close aircon|set @ on|set @ off|1`
`define hygrostat THRESHOLD hym_sens:humidity:20 watering|set @ off|set @ on|2`
It can also FHEM/perl command chains are specified:
Examples:
`define thermostat THRESHOLD sensor |set Switch1 on;;set Switch2 on|set Switch1 off;;set Switch2 off|1`
`define thermostat THRESHOLD sensor alarm|{Log 2,"value is exceeded"}|set @ on;;set Switch2 on`
`define thermostat THRESHOLD sensor ||{Log 2,"value is reached"}|`
Examples of the reference input by another sensor:
Hot water circulation: The return temperature is 5 degrees (offset) below the hot water tank temperature and can vary by up to 4 degrees (hysteresis).
`define TH_water_circulation THRESHOLD return_w:temperature:4:water_storage:temperature:-5 circualtion_pump`
Control of heating by a wall thermostat with acquisition the desired and actual temperature from the wall thermostat:
`define TH_heating THRESHOLD WT:measured-temp:1:WT:desired-temp heating`
`set TH_heating desired 17` overrides the desired-values from the wall thermostat until called `set TH_heating external`
Examples of customized state output:
`define thermostat THRESHOLD sensor aircon|set @ on|set @ off|2|on:off`
Example of state output (eg for state evaluation in other modules) without executing code:
`define thermostat THRESHOLD sensor:temperature:0:30`
by reason of default values​​:
`define thermostat THRESHOLD sensor:temperature:0:30||||off:on|_sc`
Example of combining several THRESHOLD modules together:
It should be heated when the room temperature drops below 21 degrees and the outside temperature is below 15 degrees:
`define TH_outdoor THRESHOLD outdoor:temperature:0:15`
`define TH_room THRESHOLD indoor OR TH_outdoor:state:off heating`
`set TH_room desired 21`
An example of time-dependent heating in combination with DOIF module:
`define TH_room THRESHOLD T_living_room heating`
`define di_room DOIF ([05:30-23:00|8] or [07:00-23:00|7]) (set TH_room desired 20) DOELSE (set TH_room desired 18)`
Examples of customized state output:
State output: <mode> <state_cmd> <desired_value> <sensor_value>
`define TH_living_room THRESHOLD T_living_room heating|set @ off|set @ on|2|off:on|_m _sc _dv _s1v`
or
`define TH_living_room THRESHOLD T_living_room heating`
`attr TH_living_room state_cmd1_gt off`
`attr TH_living_room state_cmd2_lt on`
`attr TH_living_room state_format _m _sc _dv _s1v`

Set

- `set <name> desired <value>
  ` Set the desired value. If no desired value is set, the module is not active.
- `set <name> deactivated <command>
  ` Module is disabled.
  <command> is optional. It can be "cmd1_gt" or "cmd2_lt" passed in order to achieve a defined state before disabling the module.
- `set <name> active <value>
  ` Module is activated. If under target_value a sensor for reference input has been defined, the current setpoint will be inhibited until set "set <name> external".
- `set <name> externel
  ` Module is activated, reference input comes from the target sensor, if a sensor has been defined under target_value.
- `set <name> hysteresis <value>
  ` Set hysteresis value.
- `set <name> offset <value>
  ` Set offset value.
  Defaultwert: 0
- `set <name> cmd1_gt`
  Executes the command defined in cmd1_gt.
- `set <name> cmd2_lt`
  Executes the command defined in cmd2_lt.

Get

N/A

Attributes

- disable
- loglevel
- state_cmd1_gt
- state_cmd2_lt
- state_format
- number_format
The specified format is used in the state for formatting desired_value (_dv) and Sensor_value (_s1v) using the sprintf function.
The default value is "% .1f" to one decimal place. Other formatting, see Formatting in the sprintf function in the Perldokumentation.
If the attribute is deleted, numbers are not formatted in the state.
- target_func
Here, a Perl expression used to calculate a target value from a value of the external sensor.
The sensor value is given as "_tv" in the expression.
Example:
`attr TH_heating target_func -0.578*_tv+33.56`
- setOnDeactivated
Command to be executed before deactivating. Possible values: cmd1_gt, cmd2_lt
- desiredActivate
If the attribute is set to 1, a disabled module is automatically activated by "set ... desired <value>". "set ... active" is not needed in this case.

### THZ

THZ module: comunicate through serial interface RS232/USB (eg /dev/ttyxx) or through ser2net (e.g 10.0.x.x:5555) with a Tecalor/Stiebel Eltron heatpump.
Tested on a THZ303/Sol (with serial speed 57600/115200@USB) and a THZ403 (with serial speed 115200) with the same Firmware 4.39.
Tested on a LWZ404 (with serial speed 115200) with Firmware 5.39.
Tested on fritzbox, nas-qnap, raspi and macos.
Implemented: read of status parameters and read/write of configuration parameters. A complete description can be found in the 00_THZ wiki http://www.fhemwiki.de/wiki/Tecalor_THZ_Heatpump
Define

`define <name> THZ <device>`
`device` can take the same parameters (@baudrate, @directio, TCP/IP, none) like the CUL, e.g 57600 baud or 115200.
Example: direct connection

`define Mytecalor THZ /dev/ttyUSB0@115200
`

or network connection (like via ser2net)

`define Myremotetecalor THZ 192.168.0.244:2323`

`define Mythz THZ /dev/ttyUSB0@115200
define FileLog_Mythz FileLog ./log/Mythz-%Y.log Mythz
attr Mythz event-min-interval s.*:4800
attr Mythz event-on-change-reading .*
attr Mythz interval_sDHW 400
attr Mythz interval_sElectrDHWDay 2400
attr Mythz interval_sElectrDHWTotal 43200
attr Mythz interval_sGlobal 400
attr Mythz interval_sHC1 400
attr Mythz interval_sHeatDHWDay 2400
attr Mythz interval_sHeatDHWTotal 43200
attr Mythz interval_sHeatRecoveredDay 2400
attr Mythz interval_sHeatRecoveredTotal 43200
attr Mythz interval_sHistory 86400
attr Mythz interval_sLast10errors 86400
attr Mythz room pompa
attr FileLog_Mythz room pompa
`

If the attributes interval_XXXX are not defined (or 0 seconds), their internal polling is disabled.
This module is starting to support older firmware 2.06 or newer firmware 5.39; the following attribute adapts decoding

`attr Mythz firmware 2.06
`

`attr Mythz firmware 5.39
`

If no attribute firmware is set, it is assumed your firmware is compatible with 4.39.
A backup function has been implemented

`get Mythz zBackupParameters implemented`

The command saves all pXXX in a backupfile with a special text format. All (or some) parameters can be easily restored with one copy&paste from the backupfile in a telnet fhem session.

### TPLinkHS110

Define `define <name> TPLinkHS110 <ip/hostname>`
Defines a TP-Link HS100 or HS110 wifi-controlled switchable power outlet.
The difference between HS100 and HS110 is, that the HS110 provides realtime measurments of
power, current and voltage.
This module automatically detects the modul defined and adapts the readings accordingly.
This module does not implement all functions of the HS100/110.
Currently, all parameters relevant for running the outlet under FHEM are processed.
Writeable are only "On", "Off" and the nightmode (On/Off) (Nightmode: the LEDs of the outlet are switched off).
Further programming of the outlet should be done by TPLinks app "Kasa", which funtionality is partly redundant
with FHEMs core functions.

Attributs

- interval: The interval in seconds, after which FHEM will update the current measurements. Default: 300s
An update of the measurements is done on each switch (On/Off) as well.

- timeout: Timeout in seconds used while communicationg with the outlet. Default: 1s
Warning:: the timeout of 1s is chosen fairly aggressive. It could lead to errors, if the outlet is not answerings the requests within this timeout.
Please consider, that raising the timeout could mean blocking the whole FHEM during the timeout!

- disable: The execution of the module is suspended. Default: no.
Warning: if your outlet is not on or not connected to the wifi network, consider disabling this module by the attribute "disable". Otherwise the cyclic update of the outlets measurments will lead to blockings in FHEM.

Requirements

This module uses the follwing perl-modules:
- Perl Module: IO::Socket::INET
- Perl Module: IO::Socket::Timeout

### TRAFFIC

TRAFFIC - google maps directions module
This FHEM module collects and displays data obtained via the google maps directions api
requirements:
perl JSON module
perl LWP::SIMPLE module
perl MIME::Base64 module
Google maps API key
Features:

- get distance between start and end location
- get travel time for route
- get travel time in traffic for route
- define additional waypoints
- calculate delay between travel-time and travel-time-in-traffic
- choose default language
- disable the device
- 5 log levels
- get outputs in seconds / meter (raw_data)
- state of google maps returned in error reading (i.e. The provided API key is invalid)
- customize update interval (default 3600 seconds)
- calculate ETA with localtime and delay
- configure the output readings with attribute outputReadings, text, min sec
- configure the state-reading
- optionally display the same route in return
- one-time-burst, specify the amount and interval between updates
- different Travel Modes (driving, walking, bicycling and transit)
- flexible update schedule
- integrated Map to visualize configured route at verbose 5

Define:

`define <name> TRAFFIC <YOUR-API-KEY> [UPDATE-INTERVAL]`
example:
`define muc2berlin TRAFFIC ABCDEFGHIJKLMNOPQRSTVWYZ 600`

Attributes:

- "start_address" - Street, zipcode City (mandatory)
- "end_address" - Street, zipcode City (mandatory)
- "raw_data" - 0:1
- "language" - de, en etc.
- "waypoints" - Lat, Long coordinates, separated by |
- "returnWaypoints" - Lat, Long coordinates, separated by |
- "disable" - 0:1
- "stateReading" - name the reading which will be used in device state
- "outputReadings" - define what kind of readings you want to get: text, min, sec, average
- "updateSchedule" - define a flexible update schedule, syntax <starthour>-<endhour> [<day>] <seconds> , multiple entries by sparated by |
  example: 7-9 1 120 - Monday between 7 and 9 every 2minutes
  example: 17-19 120 - every Day between 17 and 19 every 2minutes
  example: 6-8 1 60|6-8 2 60|6-8 3 60|6-8 4 60|6-8 5 60 - Monday till Friday, 60 seconds between 6 and 8 am
- "travelMode" - default: driving, options walking, bicycling or transit
- "includeReturn" - 0:1

Readings:

- delay
- distance
- duration
- duration_in_traffic
- state
- eta
- delay_min
- duration_min
- duration_in_traffic_min
- error_message

Set

- update [burst-update-count] [burst-update-interval] - update readings manually

### TRX

This module is for the RFXCOM RFXtrx433 USB based 433 Mhz RF transmitters. This USB based transmitter is able to receive and transmit many protocols like Oregon Scientific weather sensors, X10 security and lighting devices, ARC ((address code wheels) HomeEasy, KlikAanKlikUit, ByeByeStandBy, Intertechno, ELRO, AB600, Duewi, DomiaLite, COCO) and others.
Currently the following parser modules are implemented:

- 46_TRX_WEATHER.pm (see device TRX): Process messages Oregon Scientific weather sensors. See http://www.rfxcom.com/oregon.htm for a list of Oregon Scientific weather sensors that could be received by the RFXtrx433 tranmitter. Until now the following Oregon Scientific weather sensors have been tested successfully: BTHR918, BTHR918N, PCR800, RGR918, THGR228N, THGR810, THR128, THWR288A, WTGR800, WGR918. It will also work with many other Oregon sensors supported by RFXtrx433. Please give feedback if you use other sensors.
- 46_TRX_SECURITY.pm (see device TRX_SECURITY): Receive X10, KD101 and Visonic security sensors.
- 46_TRX_LIGHT.pm (see device RFXX10REC): Process X10, ARC, ELRO AB400D, Waveman, Chacon EMW200, IMPULS, RisingSun, Philips SBC, AC, HomeEasy EU and ANSLUT lighting devices (switches and remote control). ARC is a protocol used by devices from HomeEasy, KlikAanKlikUit, ByeByeStandBy, Intertechno, ELRO, AB600, Duewi, DomiaLite and COCO with address code wheels. AC is the protocol used by different brands with units having a learning mode button: KlikAanKlikUit, NEXA, CHACON, HomeEasy UK.

Note: this module requires the Device::SerialPort or Win32::SerialPort module if the devices is connected via USB or a serial port.
Define

`define <name> TRX <device> [noinit]`

USB-connected:

<device> specifies the USB port to communicate with the RFXtrx433 receiver. Normally on Linux the device will be named /dev/ttyUSBx, where x is a number. For example /dev/ttyUSB0. Please note that RFXtrx433 normally operates at 38400 baud. You may specify the baudrate used after the @ char.
Example:
`define RFXTRXUSB TRX /dev/ttyUSB0@38400`

Network-connected devices:

<device> specifies the host:port of the device. E.g. 192.168.1.5:10001

noninit is optional and issues that the RFXtrx433 device should not be initialized. This is useful if you share a RFXtrx433 device via LAN. It is also useful for testing to simulate a RFXtrx433 receiver via netcat or via FHEM2FHEM.
Example:
`define RFXTRXTCP TRX 192.168.1.5:10001`
`define RFXTRXTCP2 TRX 192.168.1.121:10001 noinit`

Attributes

- dummy
- longids
  Comma separated list of device-types for TRX_WEATHER that should be handled using long IDs. This additional ID is a one byte hex string and is generated by the Oregon sensor when is it powered on. The value seems to be randomly generated. This has the advantage that you may use more than one Oregon sensor of the same type even if it has no switch to set a sensor id. For example the author uses two BTHR918N sensors at the same time. All have different deviceids. The drawback is that the deviceid changes after changing batteries. All devices listed as longids will get an additional one byte hex string appended to the device name.
  Default is to use no long IDs.
  Examples:

      # Do not use any long IDs for any devices (this is default):
      attr RFXCOMUSB longids 0
      # Use long IDs for all devices:
      attr RFXCOMUSB longids 1
      # Use longids for BTHR918N devices.
      # Will generate devices names like BTHR918N_f3.
      attr RFXTRXUSB longids BTHR918N
      # Use longids for TX3_T and TX3_H devices.
      # Will generate devices names like TX3_T_07, TX3_T_01 ,TX3_H_07.
      attr RFXTRXUSB longids TX3_T,TX3_H

- rssi
  1: enable RSSI logging, 0: disable RSSI logging
  Default is no RSSI logging.
  Examples:

      # Do log rssi values (this is default):
      attr RFXCOMUSB rssi 0
      # Enable rssi logging for devices:
      attr RFXCOMUSB rssi 1

### TRX_ELSE

The TRX_ELSE module is invoked by TRX if a code is received by RFXCOM RFXtrx433 RF receiver that is currently not handled by a TRX_-Module. You need to define an RFXtrx433 receiver first. See TRX.
Define

`define <name> TRX_ELSE <hextype>`
`<hextype>`

specifies the hexvalue (00 - ff) of the type received by the RFXtrx433 transceiver.

Example:
`define TRX_UNKNOWN_9A TRX_ELSE 9A`

### TRX_LIGHT

The TRX_LIGHT module receives and sends X10, ARC, ELRO AB400D, Waveman, Chacon EMW200, IMPULS, RisingSun, AC, HomeEasy EU and ANSLUT lighting devices (switches and remote control). Allows to send Philips SBC (receive not possible). ARC is a protocol used by devices from HomeEasy, KlikAanKlikUit, ByeByeStandBy, Intertechno, ELRO, AB600, Duewi, DomiaLite and COCO with address code wheels. AC is the protocol used by different brands with units having a learning mode button: KlikAanKlikUit, NEXA, CHACON, HomeEasy UK.
You need to define an RFXtrx433 transceiver receiver first. See TRX.
Define

`define <name> TRX_LIGHT <type> <deviceid> <devicelog> [<deviceid2> <devicelog2>]`
`define <name> TRX_LIGHT PT2262 <deviceid> <devicelog> <commandcodes>`
`<type>`

specifies the type of the device:
Lighting devices:

- `MS14A` (X10 motion sensor. Reports [normal|alert] on the first deviceid (motion sensor) and [on|off] for the second deviceid (light sensor))
- `X10` (All other x10 devices. Report [off|on|dim|bright|all_off|all_on] on both deviceids.)
- `ARC` (ARC devices. ARC is a protocol used by devices from HomeEasy, KlikAanKlikUit, ByeByeStandBy, Intertechno, ELRO, AB600, Duewi, DomiaLite and COCO with address code wheels. Report [off|on|all_off|all_on|chime].)
- `AB400D` (ELRO AB400D devices. Report [off|on].)
- `WAVEMAN` (Waveman devices. Report [off|on].)
- `EMW200` (Chacon EMW200 devices. Report [off|on|all_off|all_on].)
- `IMPULS` (IMPULS devices. Report [off|on].)
- `RISINGSUN` (RisingSun devices. Report [off|on].)
- `PHILIPS_SBC` (Philips SBC devices. Send [off|on|all_off|all_on].)
- `ENER010` (Energenie ENER010 devices. deviceid: [A-P][1-4]. Send [off|on|all_off|all_on].)
- `ENER5` (Energenie 5-gang devices. deviceid: [A-P][1-10]. Send [off|on].)
- `COCO_GDR2` (ECOCO GDR2-2000R devices. deviceid: [A-D][1-4]. Send [off|on].)
- `AC` (AC devices. AC is the protocol used by different brands with units having a learning mode button: KlikAanKlikUit, NEXA, CHACON, HomeEasy UK. Report [off|on|level <NUM>|all_off|all_on|all_level <NUM>].)
- `HOMEEASY` (HomeEasy EU devices. Report [off|on|level|all_off|all_on|all_level].)
- `ANSLUT` (Anslut devices. Report [off|on|level|all_off|all_on|all_level].)
- `PT2262` (Devices using PT2262/PT2272 (coder/decoder) chip. To use this enable Lighting4 in RFXmngr. Please note that this disables ARC. For more information see FHEM-Wiki)
- `LIGHTWAVERF` (LightwaveRF devices. Commands ["off", "on", "all_off", "mood1", "mood2", "mood3", "mood4", "mood5", "reserved1", "reserved2", "unlock", "lock", "all_lock", "close", "stop", "open", "level"].)
- `EMW100` (EMW100 devices. Commands ["off", "on", "learn"].)
- `BBSB` (BBSB devices. Commands ["off", "on", "all_off", "all_on"].)
- `MDREMOTE` (MDREMOTE LED dimmer devices. Commands ["power", "light", "bright", "dim", "100", "50", "25", "mode+", "speed-", "speed+", "mode-"].)
- `RSL2` (Conrad RSL2 devices. Commands ["off", "on", "all_off", "all_on"].)
- `LIVOLO` (Livolo devices. Commands ["all_off", "on_off", "dim+", "dim-"].)
- `TRC02` (RGB TRC02 devices. Commands ["off", "on", "bright", "dim", "vivid", "pale", "color"].)
- `BLYSS` (Blyss devices. deviceid: [A-P][1-5]. Commands ["off", "on", "all_off", "all_on"].)
- `BYRONSX` (Byron SX chime devices. deviceid: 00-FF. Commands [ "tubular3_1", "solo1", "bigben1", "tubular2_1", "tubular2_2", "solo2", "tubular3_2"].)
- `SELECTPLUS` (SELECTPLUS] chime devices. deviceid: 0000-FFFF. Commands [ "ring"].)
- `SIEMENS_SF01` (Siemens SF01 devices. deviceid: 000000-007FFF. Commands [ "timer", "-", "learn", "+", "confirm", "light", "on", "off" ].)
- `HARRISON` (Harrison curtain devices. deviceid: 00-FF. Commands [ "open", "close", "stop", "program" ].)
- `ROLLER_TROL` (Roller Trol blind devices. deviceid: 00000100-00FFFF0F. Commands [ "open", "close", "stop", "confirm_pair", "set_limit" ].)
- `HASTA_OLD` (Hasta old blind devices. deviceid: 00000100-00FFFF0F. Commands [ "open", "close", "stop", "confirm_pair", "set_limit" ].)
- `AOK_RF01` (A-OK RF01 blind devices. deviceid: 00000100-FFFFFF0F. Commands [ "open", "close", "stop", "confirm_pair" ].)
- `AOK_AC114` (A-OK AC114 blind devices. deviceid: 00000100-FFFFFF0F. Commands [ "open", "close", "stop", "confirm_pair" ].)
- `RAEX_YR1326` (Raex YR1326 blind devices. deviceid: 00000100-FFFFFF0F. Commands [ "open", "close", "stop", "confirm_pair", "set_upper_limit", "set_lower_limit", "delete_limits", "change_dir", "left", "right"].)
- `MEDIA_MOUNT` (Media Mount blind devices. deviceid: 00000100-FFFFFF0F. Commands [ "down", "up", "stop" ].)
- `DC106` (DC/RMF/Yooda blind devices. deviceid: 00000100-FFFFFFF0. Commands [ "open", "close", "stop", "confirm" ].)
- `FOREST` (Forest blind devices. deviceid: 00000100-FFFFFFF0. Commands [ "open", "close", "stop", "confirm_pair" ].)
- `RFY` (Somfy RTS devices. deviceid: 000001-0FFFFF, unicode: 01-04 (00 = allunits). Commands [ "up", "down", "stop", "program" ].)
- `RFY_ext` (Somfy RTS devices. deviceid: 000001-0FFFFF, unicode: 00-0F. Commands [ "up", "down", "stop", "program" ].)

`<deviceid>`

specifies the first device id of the device.
A lighting device normally has a house code A..P followed by a unitcode 1..16 (example "B1").
For AC, HomeEasy EU and ANSLUT it is a 10 Character-Hex-String for the deviceid, consisting of
- unid-id: 8-Char-Hex: 00000001 to 03FFFFFF
- unit-code: 2-Char-Hex: 01 to 10
For LIGHTWAVERF, EMW100, BBSB, MDREMOTE, RSL2, LIVOLO and TRC02 it is a 8 Character-Hex-String for the deviceid, consisting of
- unid-id: 8-Char-Hex: 000001 to FFFFFF
- unit-code: 2-Char-Hex: 01 to 10
For RFY and RFY-ext it is a 8 Character-Hex-String for the deviceid, consisting of
- unid-id: 8-Char-Hex: 000001 to FFFFFF
- unit-code: 2-Char-Hex: 01 to 04 for RFY (00 for all units) and 00 to 0F for RFY_ext

`<devicelog>`

is the name of the Reading used to report. Suggested: "motion" for motion sensors. If you use "none" then no additional Reading is reported. Just the state is used to report the change.

`<deviceid2>`

is optional and specifies the second device id of the device if it exists. For example ms14a motion sensors report motion status on the first deviceid and the status of the light sensor on the second deviceid.

`<devicelog2>`

is optional for the name used for the Reading of `<deviceid2>`.If you use "none" then no addional Reading is reported. Just the state is used to report the change.

`<commandcodes>`

is used for PT2262 and specifies the possible base4 digits for the command separated by : and a string that specifies a string that is the command. Example '`0:off,1:on`'.

Example:
`define motion_sensor2 TRX_LIGHT MS14A A1 motion A2 light`
`define Steckdose TRX_LIGHT ARC G2 light`
`define light TRX_LIGHT AC 0101010101 light`

Set

`set <name> <value> [<levelnum>]`
where `value` is one of:

        off
        on
        dim                # only for X10, KOPPLA
        bright             # only for X10, KOPPLA
        all_off            # only for X10, ARC, EMW200, AC, HOMEEASY, ANSLUT
        all_on             # only for X10, ARC, EMW200, AC, HOMEEASY, ANSLUT
        chime              # only for ARC
        level <levelnum>    # only AC, HOMEEASY, ANSLUT: set level to <levelnum> (range: 0=0% to 15=100%)
        on-till           # Special, see the note
        on-for-timer      # Special, see the note
        ring              # Byron MP001,SelectPlus, RFU, Envivo

Example:
`set Steckdose on`
Notes:

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

Get

N/A

Attributes

- ignore
- do_not_notify
- readingFnAttributes

### TRX_SECURITY

The TRX_SECURITY module interprets X10, KD101 and Visonic security sensors received by a RFXCOM RFXtrx433 RF receiver. You need to define an RFXtrx433 receiver first. See TRX.
Define

`define <name> TRX_SECURITY <type> <deviceid> <devicelog> [<deviceid2> <devicelog2>]`
`<type>`

specifies one of the following security devices:

- `DS10A` (X10 security ds10a Door/Window Sensor or compatible devices. This device type reports the status of the switch [Open/Closed], status of the delay switch [min|max]], and battery status [ok|low].)
- `SD18` or `COD18`(X10 security sd18 smoke Sensor and COD18 CO Sensor). These device types report the status of the sensor [alert/normal] and battery status [ok|low])
- `MS10A` (X10 security ms10a motion sensor. This device type reports the status of motion sensor [normal|alert] and battery status [ok|low].))
- `SD90` (Marmitek sd90 smoke detector. This device type reports the status of the smoke detector [normal|alert] and battery status [ok|low].)
- `KR18` (X10 security remote control. Report the Reading "Security" with values [Arm|Disarm], "ButtonA" and "ButtonB" with values [on|off] )
- `KD101` (KD101 smoke sensor. Report the Reading "smoke" with values [normal|alert])
- `VISONIC_WINDOW` (VISONIC security Door/Window Sensor or compatible devices. This device type reports the status of the switch [Open/Closed] and battery status [ok|low].)
- `VISONIC_MOTION` (VISONIC security motion sensor. This device type reports the status of motion sensor [normal|alert] and battery status [ok|low].))

`<deviceid>`

specifies the first device id of the device. X10 security (DS10A, MS10A) and SD90 have a a 16 bit device id which has to be written as a hex-string (example "5a54"). All other devices have a 24 bit device id.

`<devicelog>`

is the name of the Reading used to report. Suggested: "Window" or "Door" for ds10a, "motion" for motion sensors, "smoke" for sd90, sd18 and cod18. If you use "none" then no additional Reading is reported. Just the state is used to report the change.

`<deviceid2>`

is optional and specifies the second device id of the device if it exists. For example sd90 smoke sensors can be configured to report two device ids.

`<devicelog2>`

is optional for the name used for the Reading of `<deviceid2>`. If you use "none" then no additional Reading is reported. Just the state is used to report the change.

Example:
`define livingroom_window TRX_SECURITY ds10a 72cd Window`
`define motion_sensor1 TRX_SECURITY ms10a 55c6 motion`
`define smoke_sensor1 TRX_SECURITY sd90 54d3 Smoke 54d3 Smoketest`

Set

`set <name> <value>`
where `value` is one of:

        alert              # only for KD101
        pair               # only for KD101

Example:
`set TRX_KD101_a5ca00 alert`

Get

N/A

Attributes

- ignore
- do_not_notify
- readingFnAttributes

### TRX_WEATHER

The TRX_WEATHER module interprets weather sensor messages received by a RTXtrx receiver. See http://www.rfxcom.com/oregon.htm for a list of Oregon Scientific weather sensors that could be received by the RFXtrx433 tranmitter. You need to define a RFXtrx433 receiver first. See See TRX.
Define

`define <name> TRX_WEATHER <deviceid>`
`<deviceid>`

is the device identifier of the sensor. It consists of the sensors name and (only if the attribute longids is set of the RFXtrx433) an a one byte hex string (00-ff) that identifies the sensor. If an sensor uses an switch to set an additional is then this is also added. The define statement with the deviceid is generated automatically by autocreate. The following sensor names are used:
"THR128" (for THR128/138, THC138),
"THGR132N" (for THC238/268,THN132,THWR288,THRN122,THN122,AW129/131),
"THWR800",
"RTHN318",
"TX3_T" (for LaCrosse TX3, TX4, TX17),
"THGR228N" (for THGN122/123, THGN132, THGR122/228/238/268),
"THGR810",
"RTGR328",
"THGR328",
"WTGR800_T" (for temperature of WTGR800),
"THGR918" (for THGR918, THGRN228, THGN500),
"TFATS34C" (for TFA TS34C),
"BTHR918",
"BTHR918N (for BTHR918N, BTHR968),
"RGR918" (for RGR126/682/918),
"PCR800",
"TFA_RAIN" (for TFA rain sensor),
"WTGR800_A" (for wind sensor of WTGR800),
"WGR800" (for wind sensor of WGR800),
"WGR918" (for wind sensor of STR918 and WGR918),
"TFA_WIND" (for TFA wind sensor),
"BWR101" (for Oregon Scientific BWR101),
"GR101" (for Oregon Scientific GR101) "TLX7506" (for Digimax TLX7506),
"TH10" (for Digimax with short format),

Example:

`define Tempsensor TRX_WEATHER TX3_T`
`define Tempsensor3 TRX_WEATHER THR128_3`
`define Windsensor TRX_WEATHER WGR918_A`
`define Regensensor TRX_WEATHER RGR918`

`define <name> TRX_WEATHER <deviceid> [<scale_current> <scale_total> <add_total>]`
`<deviceid>`

is the device identifier of the energy sensor. It consists of the sensors name and (only if the attribute longids is set of the RFXtrx433) an a two byte hex string (0000-ffff) that identifies the sensor. The define statement with the deviceid is generated automatically by autocreate. The following sensor names are used:
"CM160" (for OWL CM119 or CM160),
"CM180" (for OWL CM180),
"CM180i"(for OWL CM180i),

The following Readings are generated:

`"energy_current:"`:

Only for CM160 and CM180: current usage in Watt. If <scale_current> is defined the result is: `energy_current * <scale_current>`.

`"energy_chx:"`:

Only for CM180i (where chx is ch1, ch2 or ch3): current usage in Ampere. If <scale_current> is defined the result is: `energy_chx * <scale_current>`.

`"energy_total:"`:

current usage in kWh. If scale_total and add_total is defined the result is: `energy_total * <scale_total> + <add_total>`.

Example:

`define Tempsensor TRX_WEATHER CM160_1401`
`define Tempsensor TRX_WEATHER CM180_1401 1 1 0`
`define Tempsensor TRX_WEATHER CM180_1401 0.9 0.9 -1000`

Set

N/A

Get

N/A

Attributes

- ignore
- do_not_notify
- readingFnAttributes

### TUL

The TUL module is the representation of a EIB / KNX connector in FHEM. KNX instances represent the EIB / KNX devices and will need a TUL as IODev to communicate with the EIB / KNX network.
The TUL module is designed to connect to EIB network either using eibd, knxd or the TUL usb stick created by busware.de Note: this module may require the Device::SerialPort or Win32::SerialPort module if you attach the device via USB and the OS sets strange default parameters for serial devices.

Define

`define <name> TUL <device> <physical address>`
TUL usb stick / TPUART serial devices:

<device> specifies the serial port to communicate with the TUL. 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 TUL 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@19200
Note: For TUL usb stick the baudrate 19200 is needed and this is the default when no baudrate is given.
Example:
`define tul TUL tul:/dev/ttyACM0 1.1.249`

EIBD:

<device> specifies the host:port of the eibd device. E.g. eibd:192.168.0.244:2323. When using the standard port, the port can be omitted.
Example:
`define tul TUL eibd:localhost 1.1.249` `define tul TUL knxd:192.168.178.1 1.1.248`

If the device is called none, then no device will be opened, so you can experiment without hardware attached.
The physical address is used as the source address of telegrams sent to EIB network.

Attributes

- do_not_notify
- dummy
- showtime
- verbose
- useEIB

The device operates the module 10_EIB, if this flag is set to 1. This is used for backward compatibility only. Otherwise, only the client 10_KNX is used.

### TechemHKV

This module reads the transmission of techem data meter for heating device.
It will display

- meter data for current billing period
- meter data for previous billing period including date of request
- both temperature sensors (if supported by data meter)

It will require a CUL in WMBUS_T mode, although the CUL may temporary set into that mode. The module keeps track of the CUL rfmode.
Define
`define <name> TechemHKV <4|8 digit ID> [<speaking name>]`

- ID: 4 digit ID displayed at techem or 8 digit as printed on bill
- speaking name: (optional) human readable identification

Readings

- current_period: meter data for current billing period
  unit-less data, cumulated since start of the current billing period. The reading will be updated once a day, after receiving the first update. Reading time will reflect the time of data (not the time where they were received)
- previous_period: meter data for last billing period
  unit-less data, sum of the last billing period. The reading will be updated only if a new billing period starts. Reading time will reflect the last day of previous billing period (not the time where they were received)
- temp1: ambient temperature
- temp2: heater surface temperature

Internals

- friendly: human readable identification of meter as specified by define
- longID: 8 digit id of meter

### TechemWZ

This module reads the transmission of techem volume data meter. Currently supported device:

- Messkapsel-Wasserzähler radio 3 (cold, warm water)
- Messkapsel-Wärmemengenzähler compact V (heating energy)

It will display

- meter data for current billing period
- meter data for previous billing period including date of request
- cumulative meter data

It will require a CUL in WMBUS_T mode, although the CUL may temporary set into that mode. The module keeps track of the CUL rfmode.
preliminary

Techem volume data meter does not transmit their printed meter ID. Instead they transmit the ID of the build in radio module.

Therefore a "list-mode" is available which collects all Techem meter device in range to help you find out the right one. That "list-mode" will be activated by defining a TechemWZ device with id "00000000". Let it run for a while and do a "get <name> list". You will see a list of available (received) Techem device with their ID and meter data. Choose the right one (keep in mind that the meter reading reflects last midnight), note down their ID and define the appropriate device. After done the device with ID "00000000" can be removed.
Define
`define <name> TechemWZ <8 digit ID> [<speaking name>]`

- ID: 8 digit ID (see list mode above)
- speaking name: (optional) human readable identification

Readings

- current_period: meter data for current billing period
  cumulated since the start of the current billing period. The reading will be updated once a day, after receiving the first update. Reading time will reflect the time of data (not the time where the data were received)
- previous_period: meter data for last billing period
  meter rading at the end of the last billing period. The reading will be updated if a new billing period starts. Reading time will reflect the last day of previous billing period (not the time where the data were received)
- meter: cumulative meter data.
  The same data that will be shown at the Techem (mechanical) display

Get

- list: print a list of available (received) Techem device with their ID and meter data
  only available if device ID is "00000000" (list-mode)

Internals

- friendly: human readable identification of meter as specified by define

### TelegramBot

The TelegramBot module allows the usage of the instant messaging service Telegram from FHEM in both directions (sending and receiving). So FHEM can use telegram for notifications of states or alerts, general informations and actions can be triggered.
TelegramBot makes use of the telegram bot api and does NOT rely on any addition local client installed.
Telegram Bots are different from normal telegram accounts, without being connected to a phone number. Instead bots need to be registered through the BotFather to gain the needed token for authorizing as bot with telegram.org. This is done by connecting (in a telegram client) to the BotFather and sending the command `/newbot` and follow the steps specified by the BotFather. This results in a token, this token (e.g. something like `110201543:AAHdqTcvCH1vGWJxfSeofSAs0K5PALDsaw` is required for defining a working telegram bot in fhem.
Bots also differ in other aspects from normal telegram accounts. Here some examples:

- Bots can not initiate connections to arbitrary users, instead users need to first initiate the communication with the bot.
- Bots have a different privacy setting then normal users (see Privacy mode)
- Bots support commands and specialized keyboards for the interaction (not yet supported in the fhem telegramBot)

Note:

- This module requires the perl JSON module.
  Please install the module (e.g. with `sudo apt-get install libjson-perl`) or the correct method for the underlying platform/system.
- The attribute pollingTimeout needs to be set to a value greater than zero, to define the interval of receiving messages (if not set or set to 0, no messages will be received!)
- Multiple infomations are stored in readings (esp contacts) and internals that are needed for the bot operation, so having an recent statefile will help in correct operation of the bot. Generally it is recommended to regularly store the statefile (see save command)

The TelegramBot module allows receiving of messages from any peer (telegram user) and can send messages to known users. The contacts/peers, that are known to the bot are stored in a reading (named `Contacts`) and also internally in the module in a hashed list to allow the usage of contact ids and also full names and usernames. Contact ids are made up from only digits, user names are prefixed with a @, group names are prefixed with a #. All other names will be considered as full names of contacts. Here any spaces in the name need to be replaced by underscores (_). Each contact is considered a triple of contact id, full name (spaces replaced by underscores) and username or groupname prefixed by @ respectively #. The three parts are separated by a colon (:).
Contacts are collected automatically during communication by new users contacting the bot or users mentioned in messages.
Updates and messages are received via long poll of the GetUpdates message. This message currently supports a maximum of 20 sec long poll. In case of failures delays are taken between new calls of GetUpdates. In this case there might be increasing delays between sending and receiving messages!
Beside pure text messages also media messages can be sent and received. This includes audio, video, images, documents, locations and venues.
Define

`define <name> TelegramBot <token>`
Defines a TelegramBot device using the specified token perceived from botfather
Example:

`define teleBot TelegramBot 110201543:AAHdqTcvCH1vGWJxfSeofSAs0K5PALDsaw`

Set

- `message|msg|_msg|send [ @<peer1> ... @<peerN> ] [ (<keyrow1>) ... (<keyrowN>) ] <text>`
  Sends the given message to the given peer or if peer(s) is ommitted currently defined default peer user. Each peer given needs to be always prefixed with a '@'. Peers can be specified as contact ids, full names (with underscore instead of space), usernames (prefixed with another @) or chat names (also known as groups in telegram groups must be prefixed with #). Multiple peers are to be separated by space
  A reply keyboard can be specified by adding a list of strings enclosed in parentheses "()". Each separate string will make one keyboard row in a reply keyboard. The different keys in the row need to be separated by |. The key strings can contain spaces.
  Messages do not need to be quoted if containing spaces. If you want to use parentheses at the start of the message than add one extra character before the parentheses (i.e. an underline) to avoid the message being parsed as a keyboard
  Examples:
  `set aTelegramBotDevice message @@someusername a message to be sent`
    to send to a peer having someusername as username (not first and last name) in telegram
  `set aTelegramBotDevice message (yes) (may be) are you there?`
    to send the message "are you there?" and provide a reply keyboard with two buttons ("yes" and "may be") on separate rows to the default peer
  `set aTelegramBotDevice message @@someusername (yes) (may be) are you there?`
    to send the message from above with reply keyboard to a peer having someusername as username
  `set aTelegramBotDevice message (yes|no) (may be) are you there?`
    to send the message from above with reply keyboard having 3 keys, 2 in the first row ("yes" / "no") and a second row with just one key to the default peer
  `set aTelegramBotDevice message @@someusername @1234567 a message to be sent to multiple receipients`
    to send to a peer having someusername as username (not first and last name) in telegram
  `set aTelegramBotDevice message @Ralf_Mustermann another message`
    to send to a peer with Ralf as firstname and Mustermann as last name in telegram
  `set aTelegramBotDevice message @#justchatting Hello`
    to send the message "Hello" to a chat with the name "justchatting"
  `set aTelegramBotDevice message @1234567 Bye`
    to send the message "Bye" to a contact or chat with the id "1234567". Chat ids might be negative and need to be specified with a leading hyphen (-).
- `msgForceReply [ @<peer1> ... @<peerN> ] <text>`
  Sends the given message to the recipient(s) and requests (forces) a reply. Handling of peers is equal to the message command. Adding reply keyboards is currently not supported by telegram.
- `reply <msgid> [ @<peer1> ] <text>`
  Sends the given message as a reply to the msgid (number) given to the given peer or if peer is ommitted to the defined default peer user. Only a single peer can be specified. Beside the handling of the message as a reply to a message received earlier, the peer and message handling is otherwise identical to the msg command.
- `msgEdit <msgid> [ @<peer1> ] <text>`
  Changes the given message on the recipients clients. The msgid of the message to be changed must match a valid msgId and the peers need to match the original recipient, so only a single peer can be given or if peer is ommitted the defined default peer user is used. Beside the handling of a change of an existing message, the peer and message handling is otherwise identical to the msg command.
- `queryInline [ @<peer1> ... @<peerN> ] (<keyrow1>) ... (<keyrowN>) <text>`
  Sends the given message to the recipient(s) with an inline keyboard allowing direct response
  IMPORTANT: The response coming from the keyboard will be provided in readings and a corresponding answer command with the query id is required, sicne the client is frozen otherwise waiting for the response from the bot! REMARK: inline queries are only accepted from contacts/peers that are authorized (i.e. as for executing commands, see cmdKeyword and cmdRestrictedPeer !)
- `queryEditInline <msgid> [ @<peer> ] (<keyrow1>) ... (<keyrowN>) <text>`
  Updates the original message specified with msgId with the given message to the recipient(s) with an inline keyboard allowing direct response
  With this method interactive inline dialogs are possible, since the edit of message or inline keyboard can be done multiple times.
- `queryAnswer <queryid> [ <text> ]`
  Sends the response to the inline query button press. The message is optional, the query id can be collected from the reading "callbackID". This call is mandatory on reception of an inline query from the inline command above
- `sendImage|image [ @<peer1> ... @<peerN>] <file> [<caption>]`
  Sends a photo to the given peer(s) or if ommitted to the default peer. File is specifying a filename and path to the image file to be send. Local paths should be given local to the root directory of fhem (the directory of fhem.pl e.g. /opt/fhem). Filenames with spaces need to be given in double quotes (") Rule for specifying peers are the same as for messages. Multiple peers are to be separated by space. Captions can also contain multiple words and do not need to be quoted.
- `sendMedia|sendDocument [ @<peer1> ... @<peerN>] <file>`
  Sends a media file (video, audio, image or other file type) to the given peer(s) or if ommitted to the default peer. Handling for files and peers is as specified above.
- `sendVoice [ @<peer1> ... @<peerN>] <file>`
  Sends a voice message for playing directly in the browser to the given peer(s) or if ommitted to the default peer. Handling for files and peers is as specified above.
- `sendLocation [ @<peer1> ... @<peerN>] <latitude> <longitude>`
  Sends a location as pair of coordinates latitude and longitude as floating point numbers
  Example: `set aTelegramBotDevice sendLocation @@someusername 51.163375 10.447683` will send the coordinates of the geographical center of Germany as location.
- `replaceContacts <text>`
  Set the contacts newly from a string. Multiple contacts can be separated by a space. Each contact needs to be specified as a triple of contact id, full name and user name as explained above.
- `reset`
  Reset the internal state of the telegram bot. This is normally not needed, but can be used to reset the used URL, internal contact handling, queue of send items and polling
  ATTENTION: Messages that might be queued on the telegram server side (especially commands) might be then worked off afterwards immedately. If in doubt it is recommened to temporarily deactivate (delete) the cmdKeyword attribute before resetting.

Attributes

- `defaultPeer <name>`
  Specify contact id, user name or full name of the default peer to be used for sending messages.
- `defaultPeerCopy <1 (default) or 0>`
  Copy all command results also to the defined defaultPeer. If set results are sent both to the requestor and the defaultPeer if they are different.
- `parseModeSend <0_None or 1_Markdown or 2_HTML or 3_Inmsg >`
  Specify the parse_mode (allowing formatting of text messages) for sent text messages. 0_None is the default where no formatting is used and plain text is sent. The different formatting options for markdown or HTML are described here https://core.telegram.org/bots/api/#formatting-options. The option 3_Inmsg allows to specify the correct parse_mode at the beginning of the message (e.g. "Markdown*bold text*..." as message).
- `webPagePreview <1 or 0>`
  Disable / Enable (Default = 1) web page preview on links in messages. See parameter https://core.telegram.org/bots/api/#sendmessage as described here: https://core.telegram.org/bots/api/#sendmessage
- `cmdKeyword <keyword>`
  Specify a specific text that needs to be sent to make the rest of the message being executed as a command. So if for example cmdKeyword is set to `ok fhem` then a message starting with this string will be executed as fhem command (see also cmdTriggerOnly).
  NOTE: It is advised to set cmdRestrictedPeer for restricting access to this feature!
  Example: If this attribute is set to a value of `ok fhem` a message of `ok fhem attr telegram room IM` send to the bot would execute the command `attr telegram room IM` and set a device called telegram into room IM. The result of the cmd is sent to the requestor and in addition (if different) sent also as message to the defaultPeer (This can be controlled with the attribute `defaultPeerCopy`).
  Note: `shutdown` is not supported as a command (also in favorites) and will be rejected. This is needed to avoid reexecution of the shutdown command directly after restart (endless loop !).
- `cmdSentCommands <keyword>`
  Specify a specific text that will trigger sending the last commands back to the sender
  Example: If this attribute is set to a value of `last cmd` a message of `last cmd` woud lead to a reply with the list of the last sent fhem commands will be sent back.
  Please also consider cmdRestrictedPeer for restricting access to this feature!
- `cmdFavorites <keyword>`
  Specify a specific text that will trigger sending the list of defined favorites or executes a given favorite by number (the favorites are defined in attribute `favorites`).
  NOTE: It is advised to set cmdRestrictedPeer for restricting access to this feature!
  Example: If this attribute is set to a value of `favorite` a message of `favorite` to the bot will return a list of defined favorite commands and their index number. In the same case the message `favorite <n>` (with n being a number) would execute the command that is the n-th command in the favorites list. The result of the command will be returned as in other command executions.
- `favorites <list of commands>`
  Specify a list of favorite commands for Fhem (without cmdKeyword). Multiple commands are separated by semicolon (;). This also means that only simple commands (without embedded semicolon) can be defined.
  Favorite commands are fhem commands with an optional alias for the command given. The alias can be sent as message (instead of the favoriteCmd) to execute the command. Before the favorite command also an alias (other shortcut for the favorite) or/and a descriptive text (enclosed in []) can be specifed. If alias or description is specified this needs to be prefixed with a '/' and the alias if given needs to be specified first.
  Example: Assuming cmdFavorites is set to a value of `favorite` and this attribute is set to a value of
  `get lights status; /light=set lights on; /dark[Make it dark]=set lights off; /heating=set heater; /[status]=get heater status;`
  - Then a message "favorite1" to the bot would execute the command `get lights status`
  - A message "favorite 2" or "/light" to the bot would execute the command `set lights on`. And the favorite would show as "make it dark" in the list of favorites.
  - A message "/heating on" or "favorite 3 on" to the bot would execute the command `set heater on`
    (Attention the remainder after the alias will be added to the command in fhem!)
  - A message "favorite 4" to the bot would execute the command `get heater status` and this favorite would show as "status" as a description in the favorite list
  Favorite commands can also be prefixed with a question mark ('?') to enable a confirmation being requested before executing the command.
  Examples: `get lights status; /light=?set lights on; /dark=set lights off; ?set heater;`
  Meaning the full format for a single favorite is `/alias[description]=command` where the alias can be empty or `/alias=command` or just the `command`. In any case the command can be also prefixed with a '?'. Spaces are only allowed in the description and the command, usage of spaces in other areas might lead to wrong interpretation of the definition. Spaces and also many other characters are not supported in the alias commands by telegram, so if you want to have your favorite/alias directly recognized in then telegram app, restriction to letters, digits and underscore is required.
- `cmdRestrictedPeer <peer(s)>`
  Restrict the execution of commands only to messages sent from the given peername or multiple peernames (specified in the form of contact id, username or full name, multiple peers to be separated by a space). A message with the cmd and sender is sent to the default peer in case of another peer trying to sent messages
  It is recommended to use only peer ids for this restriction to reduce spoofing risk!
- `allowUnknownContacts <1 or 0>`
  Allow new contacts to be added automatically (1 - Default) or restrict message reception only to known contacts and unknwown contacts will be ignored (0).
- `saveStateOnContactChange <1 or 0>`
  Allow statefile being written on every new contact found, ensures new contacts not being lost on any loss of statefile. Default is on (1).
- `cmdReturnEmptyResult <1 or 0>`
  Return empty (success) message for commands (default). Otherwise return messages are only sent if a result text or error message is the result of the command execution.
- `allowedCommands <list of command>`
  Restrict the commands that can be executed through favorites and cmdKeyword to the listed commands (separated by space). Similar to the corresponding restriction in FHEMWEB. The allowedCommands will be set on the corresponding instance of an allowed device with the name "allowed_<TelegrambotDeviceName> and not on the telegramBotDevice! This allowed device is created and modified automatically.
  ATTENTION: This is not a hardened secure blocking of command execution, there might be ways to break the restriction!
- `cmdTriggerOnly <0 or 1>`
  Restrict the execution of commands only to trigger command. If this attr is set (value 1), then only the name of the trigger even has to be given (i.e. without the preceding statement trigger). So if for example cmdKeyword is set to `ok fhem` and cmdTriggerOnly is set, then a message of `ok fhem someMacro` would execute the fhem command `trigger someMacro`.
  Note: This is deprecated and will be removed in one of the next releases
- `queryAnswerText <text>`
  Specify the automatic answering to buttons send through queryInline command. If this attribute is set an automatic answer is provided to the press of the inline button. The text in the attribute is evaluated through set-logic, so that readings and also perl code can be stored here. The result of the translation with set-logic will be sent as a text with the answer (this text is currently limited by telegram to 200 characters).
  Note: A value of "0" in the attribute or as result of the evaluation will result in no text being sent with the answer.
  Note: If the peer sending the button is not authorized an answer is always sent without any text.
- `pollingTimeout <number>`
  Used to specify the timeout for long polling of updates. A value of 0 is switching off any long poll. In this case no updates are automatically received and therefore also no messages can be received. It is recommended to set the pollingtimeout to a reasonable time between 15 (not too short) and 60 (to avoid broken connections). See also attribute `disable`.
- `pollingVerbose <0_None 1_Digest 2_Log>`
  Used to limit the amount of logging for errors of the polling connection. These errors are happening regularly and usually are not consider critical, since the polling restarts automatically and pauses in case of excess errors. With the default setting "1_Digest" once a day the number of errors on the last day is logged (log level 3). With "2_Log" every error is logged with log level 2. With the setting "0_None" no errors are logged. In any case the count of errors during the last day and the last error is stored in the readings `PollingErrCount` and `PollingLastError`
- `disable <0 or 1>`
  Used to disable the polling if set to 1 (default is 0).
- `cmdTimeout <number>`
  Used to specify the timeout for sending commands. The default is a value of 30 seconds, which should be normally fine for most environments. In the case of slow or on-demand connections to the internet this parameter can be used to specify a longer time until a connection failure is considered.
- `maxFileSize <number of bytes>`
  Maximum file size in bytes for transfer of files (images). If not set the internal limit is specified as 10MB (10485760B).
- `filenameUrlEscape <0 or 1>`
  Specify if filenames can be specified using url escaping, so that special chanarcters as in URLs. This specifically allows to specify spaces in filenames as `%20`. Default is off (0).
- `maxReturnSize <number of chars>`
  Maximum size of command result returned as a text message including header (Default is unlimited). The internal shown on the device is limited to 1000 chars.
- `maxRetries <0,1,2,3,4,5>`
  Specify the number of retries for sending a message in case of a failure. The first retry is sent after 10sec, the second after 100, then after 1000s (~16min), then after 10000s (~2.5h), then after approximately a day. Setting the value to 0 (default) will result in no retries.
- `textResponseConfirm <TelegramBot FHEM : $peer\n Bestätigung \n>`
  Text to be sent when a confirmation for a command is requested. Default is shown here and $peer will be replaced with the actual contact full name if added.
- `textResponseFavorites <TelegramBot FHEM : $peer\n Favoriten \n>`
  Text to be sent as starter for the list of favorites. Default is shown here and $peer will be replaced with the actual contact full name if added.
- `textResponseCommands <TelegramBot FHEM : $peer\n Letzte Befehle \n>`
  Text to be sent as starter for the list of last commands. Default is shown here and $peer will be replaced with the actual contact full name if added.
- `textResponseResult <TelegramBot FHEM : $peer\n Befehl:$cmd:\n Ergebnis:\n$result\n>`
  Text to be sent as result for a cmd execution. Default is shown here and $peer will be replaced with the actual contact full name if added. Similarly $cmd and $result will be replaced with the cmd and the execution result. If the result is a response with just spaces, or other separator characters the result will be not sent at all (i.e. a values of "\n") will result in no message at all.
- `textResponseUnauthorized <UNAUTHORIZED: TelegramBot FHEM request from user :$peer\n Msg: $msg>`
  Text to be sent as warning for unauthorized command requests. Default is shown here and $peer will be replaced with the actual contact full name and id if added. $msg will be replaced with the sent message.

Readings

- Contacts <text>
  The current list of contacts known to the telegram bot. Each contact is specified as a triple in the same form as described above. Multiple contacts separated by a space.
- msgId <text>
  The id of the last received message is stored in this reading. For secret chats a value of -1 will be given, since the msgIds of secret messages are not part of the consecutive numbering
- msgPeer <text>
  The sender name of the last received message (either full name or if not available @username)
- msgPeerId <text>
  The sender id of the last received message
- msgText <text>
  The last received message text is stored in this reading. Information about special messages like documents, audio, video, locations or venues will be also stored in this reading
- msgFileId <fileid>
  The last received message file_id (Audio, Photo, Video, Voice or other Document) is stored in this reading.
- msgReplyMsgId <text>
  Contains the message id of the original message, that this message was a reply to
- prevMsgId <text>
  The id of the SECOND last received message is stored in this reading
- prevMsgPeer <text>
  The sender name of the SECOND last received message (either full name or if not available @username)
- prevMsgPeerId <text>
  The sender id of the SECOND last received message
- prevMsgText <text>
  The SECOND last received message text is stored in this reading
- prevMsgFileId <fileid>
  The SECOND last received file id is stored in this reading
Note: All prev... Readings are not triggering events
- sentMsgId <text>
  The id of the last sent message is stored in this reading, if not succesful the id is empty
- sentMsgResult <text>
  The result of the send process for the last message is contained in this reading - SUCCESS if succesful
- StoredCommands <text>
  A list of the last commands executed through TelegramBot. Maximum 10 commands are stored.
- PollingErrCount <number>
  Show the number of polling errors during the last day. The number is reset at the beginning of the next day.
- PollingLastError <number>
  Last error message that occured during a polling update call
- callbackID <id> / callbackPeerId <peer id> / callbackPeer <peer>
  Contains the query ID (respective the peer id and peer name) of the last received inline query from an inline query button (see set ... inline)

Examples

- Send a telegram message if fhem has been newly started

  `define notify_fhem_reload notify global:INITIALIZED set <telegrambot> message fhem started - just now`

- A command, that will retrieve an SVG plot and send this as a message back (can be also defined as a favorite).

  Send the following message as a command to the bot `ok fhem { plotAsPng('SVG_FileLog_Aussen') }`
  assuming `ok fhem` is the command keyword)

  ( The png picture created by plotAsPng will then be send back in image format to the telegram client. This also works with other pictures returned and should also work with other media files (e.g. MP3 and doc files). The command can also be defined in a favorite.
  Remark: Example requires librsvg installed
- Allow telegram bot commands to be used
  If the keywords for commands are starting with a slash (/), the corresponding commands can be also defined with the Bot Father. So if a slash is typed a list of the commands will be automatically shown. Assuming that `cmdSentCommands` is set to `/History`. Then you can initiate the communication with the botfather, select the right bot and then with the command `/setcommands` define one or more commands like

  `History-Show a history of the last 10 executed commands`

  When typing a slash, then the text above will immediately show up in the client.

### TellStick

Define

`define <name> TellStick </path/to/tdtool>`
Defines a path to the program "tdtool", which is used to control a (locally attached) "Telldus TellStick [Duo]" USB device. A TellStick controls a wide range of 433 MHz devices, like the widely available switchable power outlets from InterTechno.
To keep things simple, FHEM interfaces with the telldus-core suite (available for Linux, Windows, Mac OSX) via the supplied tool, "tdtool". This FHEM module will initially use "tdtool --list" to receive a list of configured devices, then let autocreate (if enabled) create them as SIS_PMS devices.
Please make sure that the user running FHEM under ("fhem" in a standard setup on Linux) has the r/w-right to access the stick's device ("/dev/tellstick" in telldus-core version 2.0) — if the state of your devices do not change when modified im FHEM, access rights problems are the most probable cause (`chmod o+rw /dev/tellstick` should fix that; you may want to automate it via udev or adding the fhem user to the proper group ;))
This module has only been tested with the 2.0 branch of teldus-core because of a known bug in 2.1, preventing version 2.1 working properly with some TellSticks and/or "tdtool" application; FTR, the "Batch: 8" version a was granted usage of for writing this module was impacted by it ... To actually control any power sockets, you need to define a SIS_PMS device — TellStick.pm uses SIS_PMS devices ("socket" is te:ll:st:ck:01, "socketnr" is the ID of the device in "tdtool"), as as of now only on/off switching is supported and this was the easiest implementation path. SIS_PMS is supported by andFHEM, the Android frontend, so this make some sense. (Furthermore, I don't own dimmable devices and they are actually not really cheap; >15 EUR/socket compared to the 15 EUR for 5 switch-only, non-self learning socket adapters from Intertechno at your local home improvement store.)
Example:

`define TStick TellStick /usr/bin/tdtool`
`define Deckenfluter SIS_PMS te:ll:st:ck:01 2`

Set

N/A

Get

N/A

Attributes

- none

### Text2Speech

Define

Local : `define <name> Text2Speech <alsadevice>`
Remote: `define <name> Text2Speech <host>[:<portnr>][:SSL] [portpassword]`

This module converts any text into speech with serveral possible providers. The Device can be defined as locally or remote device.

- Local Device
  The output will be send to any connected audiodevice. For example external speakers connected per jack or with bluetooth speakers - connected per bluetooth dongle. Its important to install mplayer.
  `apt-get install mplayer`
  The given alsadevice has to be configured in `/etc/asound.conf`

  Special AlsaDevice: none
  The internal mplayer command will be without any audio directive if the given alsadevice is none. In this case mplayer is using the standard audiodevice.

  Example:
  `define MyTTS Text2Speech hw=0.0`
  `define MyTTS Text2Speech none`

- Remote Device
  This module can configured as remote-device for client-server Environments. The Client has to be configured as local device.
  Notice: the Name of the locally instance has to be the same!
  - Host: setting up IP-adress
  - PortNr: setting up TelnetPort of FHEM; default: 7072
  - SSL: setting up if connect over SSL; default: no SSL
  - PortPassword: setting up the configured target telnet passwort

  Example:
  `define MyTTS Text2Speech 192.168.178.10:7072 fhempasswd` `define MyTTS Text2Speech 192.168.178.10`

  If a PRESENCE Device is avilable for the host IP-address, than this will be used to detect the reachability instead of the blocking internal method.

Set

- tts:
  Giving a text to translate into audio. You play set mp3-files directly. In this case you have to enclosure them with a single colon before and after the declaration. The files must save under the directory of given TTS_FileTemplateDir. Please note: The text doesn´t have any colons itself.
- volume:
  Setting up the volume audio response.
  Notice: Only available in locally instances!

Get

N/A

Attributes

- TTS_Delemiter
  optional: By using the google engine, its not possible to convert more than 100 characters in a single audio brick. With a delemiter the audio brick will be split at this character. A delemiter must be a single character.!
  By default, ech audio brick will be split at sentence end. Is a single sentence longer than 100 characters, the sentence will be split additionally at comma, semicolon and the word and.
  Notice: Only available in locally instances with Google engine!
- TTS_Ressource
  optional: Selection of the Translator Engine
  Notice: Only available in locally instances!
  - Google
    Using the Google Engine. It´s nessessary to have internet access. This engine is the recommend engine because the quality is fantastic. This engine is using by default.
  - VoiceRSS
    Using the VoiceRSS Engine. Its a free engine till 350 requests per day. If you need more, you have to pay. It´s nessessary to have internet access. This engine is the 2nd recommend engine because the quality is also fantastic. To use this engine you need an APIKey (see TTS_APIKey)
  - ESpeak
    Using the ESpeak Engine. Installation Espeak and lame is required.
    `apt-get install espeak lame`
  - SVOX-pico
    Using the SVOX-Pico TTS-Engine (from the AOSP).
    Installation of the engine and `lame` is required:
    `sudo apt-get install libttspico-utils lame`
    On ARM/Raspbian the package `libttspico-utils`,
    so you may have to compile it yourself or use the precompiled package from this guide, in short:
    `sudo apt-get install libpopt-dev lame`
    `cd /tmp`
    `wget http://www.dr-bischoff.de/raspi/pico2wave.deb`
    `sudo dpkg --install pico2wave.deb`
- TTS_APIKey
  An APIKey its needed if you want to use VoiceRSS. You have to register at the following page:
  http://www.voicerss.org/registration.aspx
  After this, you will get your personal APIKey.
- TTS_User
  Actual without any usage. Needed in case if a TTS Engine need an username and an apikey for each request.
- TTS_CacheFileDir
  optional: The downloaded Goole audio bricks are saved in this folder for reusing. No automatically implemented deleting are available.
  Default: cache/
  Notice: Only available in locally instances!
- TTS_UseMP3Wrap
  optional: To become a liquid audio response its recommend to use the tool mp3wrap. Each downloaded audio bricks are concatinated to a single audio file to play with mplayer.
  Installtion of the mp3wrap source is required.
  `apt-get install mp3wrap`
  Notice: Only available in locally instances!
- TTS_MplayerCall
  optional: Setting up the Mplayer system call. The following example is default.
  Example: `sudo /usr/bin/mplayer`
- TTS_SentenceAppendix
  Optional: Definition of one mp3-file to append each time of audio response.
  Using of Mp3Wrap is required. The audio bricks has to be downloaded before into CacheFileDir. Example: `silence.mp3`
- TTS_FileMapping
  Definition of mp3files with a custom templatedefinition. Separated by space. All templatedefinitions can used in audiobricks by tts. The definition must begin and end with e colon. The mp3files must saved in the given directory by TTS_FIleTemplateDir.
  `attr myTTS TTS_FileMapping ring:ringtone.mp3 beep:MyBeep.mp3`
  `set MyTTS tts Attention: This is my ringtone :ring: Its loud?`
- TTS_FileTemplateDir
  Directory to save all mp3-files are defined in TTS_FileMapping und TTS_SentenceAppendix
  Optional, Default: `cache/templates`
- TTS_noStatisticsLog
  If set to 1, it prevents logging statistics to DbLog Devices, default is 0
  But please notice: this looging is important to able to delete longer unused cachefiles. If you disable this please take care to cleanup your cachedirectory by yourself.
- readingFnAttributes
- disable
  If this attribute is activated, the soundoutput will be disabled.
  Possible values: 0 => not disabled , 1 => disabled
  Default Value is 0 (not disabled)
- verbose
  4: each step will be logged
  5: Additionally the individual debug informations from mplayer and mp3wrap will be logged

Beispiele

`define MyTTS Text2Speech hw=0.0`
`set MyTTS tts Die Alarmanlage ist bereit.`
`set MyTTS tts :beep.mp3:`
`set MyTTS tts :mytemplates/alarm.mp3:Die Alarmanlage ist bereit.:ring.mp3:`

### TrashCal

Note: this module needs the HTTP::Request,HTML::Parser and LWP::UserAgent perl modules.
At this moment only city "Magdeburg" is supported at this site:
http://sab.metageneric.de/app/sab_i_tp/index.php
Define

`define <name> TrashCal <type>`
Defines a new instanze of Trashcalendar. At this time the <type> is not used
Examples:

`define MyTrashCal TrashCal Restabfall`

Set

N/A

Get

N/A

Attributes

- TrashCal_Link
  setting up the URL to grab the Trashcalendar
  Example:
  `http://sab.metageneric.de/app/sab_i_tp/index.php?r=getHausnummerInfo&strasse=Torplatz&hausnummer=1&stadtteil_id=1609&dsd_behaelter_value=b120_b240`
- readingFnAttributes
- disable
  If this attribute is activated, the module will be disabled.
  Possible values: 0 => not disabled , 1 => disabled
  Default Value is 0 (not disabled)
- verbose
  4: each major step will be logged
  5: Additionally some minor steps will be logged

### Twilight

Define

`define <name> Twilight <latitude> <longitude> [<indoor_horizon> [<Weather_Position>]]`
Defines a virtual device for Twilight calculations
latitude, longitude
The parameters latitude and longitude are decimal numbers which give the position on earth for which the twilight states shall be calculated.
indoor_horizon
The parameter indoor_horizon gives a virtual horizon, that shall be used for calculation of indoor twilight. Minimal value -6 means indoor values are the same like civil values. indoor_horizon 0 means indoor values are the same as real values. indoor_horizon > 0 means earlier indoor sunset resp. later indoor sunrise.
Weather_Position
The parameter Weather_Position is the yahoo weather id used for getting the weather condition. Go to http://weather.yahoo.com/ and enter a city or zip code. In the upcoming webpage, the id is a the end of the URL. Example: Munich, Germany -> 676757
A Twilight device periodically calculates the times of different twilight phases throughout the day. It calculates a virtual "light" element, that gives an indicator about the amount of the current daylight. Besides the location on earth it is influenced by a so called "indoor horizon" (e.g. if there are high buildings, mountains) as well as by weather conditions. Very bad weather conditions lead to a reduced daylight for nearly the whole day. The light calculated spans between 0 and 6, where the values mean the following:
light
`0 - total night, sun is at least -18 degree below horizon`
`1 - astronomical twilight, sun is between -12 and -18 degree below horizon`
`2 - nautical twilight, sun is between -6 and -12 degree below horizon`
`3 - civil twilight, sun is between 0 and -6 degree below horizon`
`4 - indoor twilight, sun is between the indoor_horizon and 0 degree below horizon (not used if indoor_horizon=0)`
`5 - weather twilight, sun is between indoor_horizon and a virtual weather horizon (the weather horizon depends on weather conditions (optional)`
`6 - maximum daylight`
Azimut, Elevation, Twilight
The module calculates additionally the azimuth and the elevation of the sun. The values can be used to control a roller shutter.
As a new (twi)light value the reading Twilight ist added. It is derived from the elevation of the sun with the formula: (Elevation+12)/18 * 100). The value allows a more detailed control of any lamp during the sunrise/sunset phase. The value ist betwenn 0% and 100% when the elevation is between -12° and 6°.
You must know, that depending on the latitude, the sun will not reach any elevation. In june/july the sun never falls in middle europe below -18°. In more northern countries(norway ...) the sun may not go below 0°.
Any control depending on the value of Twilight must consider these aspects.
Example:

          define myTwilight Twilight 49.962529  10.324845 3 676757

Set

N/A

Get

`get <name> <reading>`

light | the current virtual daylight value
nextEvent | the name of the next event
nextEventTime | the time when the next event will probably happen (during light phase 5 and 6 this is updated when weather conditions change
sr_astro | time of astronomical sunrise
sr_naut | time of nautical sunrise
sr_civil | time of civil sunrise
sr | time of sunrise
sr_indoor | time of indoor sunrise
sr_weather | time of weather sunrise
ss_weather | time of weather sunset
ss_indoor | time of indoor sunset
ss | time of sunset
ss_civil | time of civil sunset
ss_nautic | time of nautic sunset
ss_astro | time of astro sunset
azimuth | the current azimuth of the sun 0° ist north 180° is south
compasspoint | a textual representation of the compass point
elevation | the elevaltion of the sun
twilight | a percetal value of a new (twi)light value: (elevation+12)/18 * 100)
twilight_weather | a percetal value of a new (twi)light value: (elevation-WEATHER_HORIZON+12)/18 * 100). So if there is weather, it is always a little bit darker than by fair weather
condition | the yahoo condition weather code
condition_txt | the yahoo condition weather code as textual representation
horizon | value auf the actual horizon 0°, -6°, -12°, -18°

Attributes

- readingFnAttributes
- useExtWeather <device>:<reading>
use data from other devices to calculate twilight_weather.
The reading used shoud be in the range of 0 to 100 like the reading c_clouds in an openweathermap device, where 0 is clear sky and 100 are overcast clouds.
With the use of this attribute weather effects like heavy rain or thunderstorms are neglegted for the calculation of the twilight_weather reading.

Functions

- twilight($twilight, $reading, $min, $max)
- implements a routine to compute the twilighttimes like sunrise with min max values.

$twilight | name of the twilight instance
$reading | name of the reading to use example: ss_astro, ss_weather ...
$min | parameter min time - optional
$max | parameter max time - optional

Example:

        define BlindDown at *{twilight("myTwilight","sr_indoor","7:30","9:00")} set xxxx position 100
        # xxxx is a defined blind

### UNIRoll

The protocol is used by the Lott UNIROLL R-23700 reciever. The radio (868.35 MHz) messages are either received through an FHZ or an CUL device, so this must be defined first. Recieving sender messages is not integrated jet. The CUL has to allow working with zero synchbits at the beginning of a raw-message. This is possible with culfw 1.49 or higher.
Define

`define <name> UNIRoll <devicegroup> <deviceaddress>`
The values of devicegroup address (similar to the housecode) and device address (button) has to be defined as hexadecimal value. There is no master or group code integrated.

- `<devicecode>` is a 4 digit hex number, corresponding to the housecode address.
- `<channel>` is a 1 digit hex number, corresponding to a button of the transmitter.

Example:

`define roll UNIRoll 7777 0`

Set

`set <name> <value> [<time>]`
where `value` is one of:

        up
        stop
        down
        pos  (The attribute useRolloPos has to be set to 1 to use this.)
        [<time>] in seconds for up, down or pos

Examples:

`set roll up`
`set roll up 10`
`set roll1,roll2,roll3 up`
`set roll1-roll3 up`

Get

N/A

Attributes

- IODev
  Set the IO or physical device which should be used for sending signals for this "logical" device. An example for the physical device is an FHZ or a CUL. The device will not work without this entry.
- eventMap
  Replace event names and set arguments. The value of this attribute consists of a list of space separated values, each value is a colon separated pair. The first part specifies the "old" value, the second the new/desired value. If the first character is slash(/) or komma(,) then split not by space but by this character, enabling to embed spaces.
  Examples:
  `attr device eventMap up:open down:closed
  set device open`
- showtime
- sendStopBeforeCmd <value>
  Before any up/down-command a stop-command will be sent to stop a random operation. This might cause failure in some situations. This attribute can be used to switch off the stop-command by setting it to these values.
  where `value` is one of:

              1 - send always stop (default)
              0 - send no stop
              2 - send stop only before up
              3 - send stop only before down

- useRolloPos <value>
  The position of each device can be stored. By this it is possible to move from any position to any other position. As this feature is software-based, a manual operation will not be recognized. To set the device into a definite state, a up or down command will reset the counter for the position.
  where `value` is one of:

              1 - RolloPos will be used
              0 - RolloPos is not used (default)

  These attributes will be created automatical if useRolloPos is set to 1. They will not be deleted, if the value is set to 0 or the attribut is deleted.

              rMin - Time in seconds for the topmost position
              rMax - Time in seconds until the device is fully closed
              rPos - This is an internal value and must not be changed!

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

### USBWX

The USBWX module interprets the messages received by the ELV USB-WDE1 weather receiver. This receiver is compaptible with the following ELV sensors: KS200/KS300, S300IA, S300TH, ASH2200, PS50. It also known to work with Conrad weather sensors KS555, S555TH and ASH555.
This module was tested with ELV S300TH, ELV ASH2200, ELV KS300, Conrad S555TH and Conrad KS555.
Readings and STATE of temperature/humidity sensors are compatible with the CUL_WS module. For KS300/KS555 sensors STATE is compatible with the KS300 module. The module is integrated into autocreate to generate the appropriate filelogs and weblinks automatically.
Note: this module requires the Device::SerialPort or Win32::SerialPort module if the devices is connected via USB or a serial port.
Define

`define <name> USBWX <serial device>`
Defines USB-WDE1 attached via usb.
`define <name> USBWX <code> [corr1...corr4]`
<code> is the code which must be set on the sensor. Valid values are 1 through 8.
9 is used as the sensor id of the ks300 sensor.
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.
Example:

        define USBWDE1 USBWX /dev/ttyUSB0
        define USBWX_1 USBWX 1
        define USBWX_livingroom USBWX 2
        define USBWX_ks300 USBWX 9

Set

N/A

Get

N/A

Attributes

- model
- loglevel

### USF1000

Fhem can receive your tank's fill level from the USF1000S device through a FHZ device, so one must be defined first. The state contains the fill level in % (lower case v in the device state) and the current volume in liters (upper case V in the device state). Measured distance to the liquid's surface, fill level, volume and warnings (Test mode, Battery low) are available. Due to the design of the USF1000S protocol, you can have only one USF1000S in range of your FHZ as these devices cannot be distinguished.
Define

`define <name> USF1000 <geometry>`
`<geometry>` determines the form of the tank and the position of the sensor. The following geometries are currently supported:

- `cub <length> <width> <height> <offset>`
- `cylv <diameter> <height> <offset>`

`cub` stands for a cuboid whose base is <length> × <width>. `cylv` stands for a vertical cylinder whose diameter is <diameter>. <height> is the distance of the surface of the liquid from the ground if the tank is full. <offset> is the distance of the sensor relative to the surface of the liquid. All quantities are expressed in meters.
Example:

`define MyTank USF1000 cylv 2 1 0.3`: a cylindrical water tank with 2 meters diameter. The water stands 1 meter high if the tank is full. The sensor is fixed 1,3 meters above ground.

Set

N/A

Get

N/A

Attributes

- IODev
- do_not_notify
- showtime
- model (usf1000s)
- ignore
- readingFnAttributes

### UWZ

This modul extracts thunderstorm warnings from www.unwetterzentrale.de.
Therefore the same interface is used as the Android App Alerts Pro does. A maximum of 10 thunderstorm warnings will be served. Additional the module provides a few functions to create HTML-Templates which can be used with weblink.
The following Perl-Modules are used within this module: HTTP::Request, LWP::UserAgent, JSON, Encode::Guess, Text::Iconv und HTML::Parse.
Define

`define <Name> UWZ [CountryCode] [AreaID] [INTERVAL]`
Example:
`define Unwetterzentrale UWZ UK 08357 1800
attr Unwetterzentrale download 1
attr Unwetterzentrale humanreadable 1
attr Unwetterzentrale maps eastofengland unitedkingdom
define UnwetterDetails weblink htmlCode {UWZAsHtml("Unwetterzentrale")}
define UnwetterMapE_UK weblink htmlCode {UWZAsHtmlKarteLand("Unwetterzentrale","eastofengland")}
define UnwetterLite weblink htmlCode {UWZAsHtmlLite("Unwetterzentrale")} define UnwetterMovie weblink htmlCode {UWZAsHtmlMovie("Unwetterzentrale","clouds-precipitation-uk")}`
- `[CountryCode]`
  Possible values: DE, AT, CH, UK, ...
  (for other countries than germany use SEARCH for CountryCode to start device in search mode)
- `[AreaID]`
  For Germany you can use the postalcode, other countries use SEARCH for CountryCode to start device in search mode.
- `[INTERVAL]`
  Defines the refresh interval. The interval is defined in seconds, so an interval of 3600 means that every hour a refresh will be triggered onetimes.
Example Search-Mode:
`define Unwetterzentrale UWZ SEARCH
`
now get the AreaID for your location (example shows london):
`get Unwetterzentrale SearchAreaID London
`
now redefine your device with the outputted CountryCode and AreaID.

Get

- `get <name> soil-frost`
  give info about current soil frost (active|inactive).
- `get <name> extremfrost`
  give info about current frost (active|inactive).
- `get <name> thunderstorm`
  give info about current thunderstorm (active|inactive).
- `get <name> glaze`
  give info about current glaze (active|inactive).
- `get <name> glazed-rain`
  give info about current freezing rain (active|inactive).
- `get <name> hail`
  give info about current hail (active|inactive).
- `get <name> heat`
  give info about current heat (active|inactive).
- `get <name> rain`
  give info about current rain (active|inactive).
- `get <name> snow`
  give info about current snow (active|inactive).
- `get <name> storm`
  give info about current storm (active|inactive).
- `get <name> forest-fire`
  give info about current forest fire (active|inactive).

Get (Search-Mode)

- `get <name> SearchAreaID <city>`
  Get AreaID coresponnding to entered location.

Set

- `set <name> update`
  Executes an imediate update of thunderstorm warnings.

Attributes

- `download`
  Download maps during update (0|1).
- `savepath`
  Define where to store the map png files (default: /tmp/).
- `maps`
  Define the maps to download space seperated. For possible values see `UWZAsHtmlKarteLand`.
- `humanreadable`
  Add additional Readings Warn_?_Start_Date, Warn_?_Start_Time, Warn_?_End_Date and Warn_?_End_Time containing the coresponding timetamp in a human readable manner. Additionally Warn_?_uwzLevel_Str and Warn_?_Type_Str will be added to device readings (0|1).
- `lang`
  Overwrite requested language for short and long warn text. (de|en|it|fr|es|..).
- `sort_readings_by`
  define how readings will be sortet (start|severity).
- `htmlsequence`
  define warn order of html output (ascending|descending).
- `htmltitle`
  title / header for the html ouput
- `htmltitleclass`
  css-Class of title / header for the html ouput
- `localiconbase`
  define baseurl to host your own thunderstorm warn pics (filetype is png).

Readings

- Warn_0|1|2|3...|9_... - active warnings
- WarnCount - warnings count
- WarnUWZLevel - total warn level
- WarnUWZLevel_Color - total warn level color
- WarnUWZLevel_Str - total warn level string
- Warn_0_AltitudeMin - minimum altitude for warning
- Warn_0_AltitudeMax - maximum altitude for warning
- Warn_0_EventID - warning EventID
- Warn_0_Creation - warning creation
- Warn_0_Creation_Date - warning creation datum
- Warn_0_Creation_Time - warning creation time
- Warn_0_Start - begin of warnperiod
- Warn_0_Start_Date - start date of warnperiod
- Warn_0_Start_Time - start time of warnperiod
- Warn_0_End - end of warnperiod
- Warn_0_End_Date - end date of warnperiod
- Warn_0_End_Time - end time of warnperiod
- Warn_0_Severity - Severity of thunderstorm (0 no thunderstorm, 4, 7, 11, .. heavy thunderstorm)
- Warn_0_Hail - warning contains hail
- Warn_0_Type - kind of thunderstorm
- Warn_0_Type_Str - kind of thunderstorm (text)

- 1 - unknown
- 2 - storm
- 3 - snow
- 4 - rain
- 5 - frost
- 6 - forest fire
- 7 - thunderstorm
- 8 - glaze
- 9 - heat
- 10 - freezing rain
- 11 - soil frost

- Warn_0_uwzLevel - Severity of thunderstorm (0-5)
- Warn_0_uwzLevel_Str - Severity of thunderstorm (text)
- Warn_0_levelName - Level Warn Name
- Warn_0_ShortText - short warn text
- Warn_0_LongText - detailed warn text
- Warn_0_IconURL - cumulated URL to display warn-icons from www.unwetterzentrale.de

Weblinks

With the additional implemented functions `UWZAsHtml, UWZAsHtmlLite, UWZAsHtmlFP, UWZAsHtmlKarteLand and UWZAsHtmlMovie` HTML-Code will be created to display warnings and weathermovies, using weblinks.
Example:
- `define UnwetterDetailiert weblink htmlCode {UWZAsHtml("Unwetterzentrale")}`
- `define UnwetterLite weblink htmlCode {UWZAsHtmlLite("Unwetterzentrale")}`
- `define UnwetterFloorplan weblink htmlCode {UWZAsHtmlFP("Unwetterzentrale")}`
- `define UnwetterKarteLand weblink htmlCode {UWZAsHtmlKarteLand("Unwetterzentrale","Bayern")}`

- The second parameter should be one of:
  - europa
  - deutschland
  - deutschland-small
  - niedersachsen
  - bremen
  - bayern
  - schleswig-holstein
  - hamburg
  - mecklenburg-vorpommern
  - sachsen
  - sachsen-anhalt
  - nordrhein-westfalen
  - thueringen
  - rheinland-pfalz
  - saarland
  - baden-wuerttemberg
  - hessen
  - brandenburg
  - berlin
  - oesterreich
  - burgenland
  - kaernten
  - niederoesterreich
  - oberoesterreich
  - salzburg
  - steiermark
  - tirol
  - vorarlberg
  - wien
  - schweiz
  - aargau
  - appenzell_ausserrhoden
  - appenzell_innerrhoden
  - basel_landschaft
  - basel_stadt
  - bern
  - fribourg
  - geneve
  - glarus
  - graubuenden
  - jura
  - luzern
  - neuchatel
  - nidwalden
  - obwalden
  - schaffhausen
  - schwyz
  - solothurn
  - stgallen
  - ticino
  - thurgau
  - uri
  - waadt
  - wallis
  - zug
  - zuerich
  - liechtenstein
  - belgique
  - denmark
  - finnland
  - france
  - letzebuerg
  - nederland
  - norwegen
  - portugal
  - sverige
  - espana
  - unitedkingdom
  - eastofengland
  - eastmidlands
  - london
  - northeastengland
  - northernireland
  - northwestengland
  - scotland
  - southeastengland
  - southwestengland
  - wales
  - westmidlands
  - yorkshireandthehumber
  - isobaren1
  - isobaren2
  - isobaren3

- `define UnwetterKarteMovie weblink htmlCode {UWZAsHtmlMovie("Unwetterzentrale","currents")}`

- The second parameter should be one of:
  - niederschlag-wolken
  - stroemung
  - temperatur
  - niederschlag-wolken-de
  - stroemung-de
  - niederschlag-wolken-ch
  - stroemung-ch
  - niederschlag-wolken-at
  - stroemung-at
  - niederschlag-wolken-uk
  - stroemung-uk

### UbiquitiMP

FHEM module for the Ubiquiti mFi mPower modules Please read also the Wiki at http://www.fhemwiki.de/wiki/Ubiquit_mFi/mPower FHEM Forum : http://forum.fhem.de/index.php/topic,35722.0.html

Define

`define <name> UbiquitiMP <IP or FQDN>`
example :
define myPM UbiquitiMP 192.168.0.100
define myPM UbiquitiMP myhost.dyndns.org
Perl Net::Telnet and JSON module are required. On a Raspberry you can install them with :
apt-get install libjson-perl
apt-get install libnet-telnet-perl

Set

- Outx on / off (force) -> turns Port x on or off
- Outx toggle -> toggle port
- Outx lock / unlock -> protects port to switch port on/off
- Outx reset -> reset power counter for this port
- Outx enable / disable -> power counting for this port

Get

- status -> returns the status of all Outs
- info -> returns some internal informations of the device
- reboot -> reboot the device

Attributes

- ignoreList -> list of ignored ports
  e.g. attr name ignoreList 456
  ignores all values of ports 4,5 & 6
- groupPorts -> space separeted list to group ports so you can use them like a single device
  e.g. attr name groupPorts TV=12 Media=4,5,6 (GroupName=Port numbers in the group)
  set name TV on or set name Media toggle
- ledconnect -> led color since fhem connect
- subDevices -> use a single sub devices for each out port
  (default 1 for the 3 and 6 port mPower, default 0 for the mPower mini) requires 98_UbiquitiOut.pm
- interval -> polling interval in seconds, set to 0 to disable polling (default 300)
- timeout -> seconds to wait for a answer from the Power Module (default 5 seconds)
- user -> defined user on the Power Module (default ubnt)
- password -> password for user (default ubnt)

### UbiquitiOut

sub device for the UbiquitiMP or InfratekPM modul

Define

`define <name> UbiquitiOut <UbiquitiMP device> <Out #>`

Set

set Extensions

### Unifi

Unifi is the FHEM module for the Ubiquiti Networks (UBNT) - Unifi Controller.
e.g. you can use the 'presence' function, which will tell you if a device is connected to your WLAN (even in PowerSave Mode!).
Immediately after connecting to your WLAN it will set the device-reading to 'connected' and about 5 minutes after leaving your WLAN it will set the reading to 'disconnected'.
The device will be still connected, even it is in PowerSave-Mode. (In this mode the devices are not pingable, but the connection to the unifi-controller does not break off.)
Or you can use the other readings or set and get features to control your unifi-controller, accesspoints and wlan-clients.

#### Prerequisites

The Perl module JSON is required.
On Debian/Raspbian: `apt-get install libjson-perl`
Via CPAN: `cpan install JSON`

#### Define

`define <name> Unifi <ip> <port> <username> <password> [<interval> [<siteID> [<version>]]]`
<name>:

`The FHEM device name for the device.`

<ip>:

`The ip of your unifi-controller.`

<port>:

`The port of your unifi-controller. Normally it's 8443 or 443.`

<username>:

`The Username to log on.`

<password>:

`The password to log on.`

[<interval>]:

`(optional without <siteID> and <version>)
Interval to fetch the information from the unifi-api.
default: 30 seconds`

[<siteID>]:

`(optional without <version>)
You can find the site-ID by selecting the site in the UniFi web interface.
e.g. https://192.168.12.13:8443/manage/s/foobar the siteId you must use is: foobar.
default: default`

[<version>]:

`(optional if you use unifi v4)
Unifi-controller version.
Version must be specified if version is not 4. At the moment version 3 and 4 are supported.
default: 4`

#### Examples

`define my_unifi_controller Unifi 192.168.1.15 443 admin secret`
Or with optional parameters <interval>, <siteID> and <version>:
`define my_unifi_controller Unifi 192.168.1.15 443 admin secret 30 default 3`

#### Set

`Note: Some setters are not available if controller is not connected, or no data is available for them.`
- `set <name> update`
  Makes immediately a manual update.
- `set <name> clear <readings|clientData|all>`
  Clears the readings, clientData or all.
- `set <name> archiveAlerts`
  Archive all unarchived Alerts.
- `set <name> disconnectClient <all|user_id|controllerAlias|hostname|devAlias>`
  Disconnect one ore all clients.
- `set <name> restartAP <all|_id|name|ip>`
  Restart one ore all accesspoints.
- `set <name> setLocateAP <all|_id|name|ip>`
  Start 'locate' on one or all accesspoints.
- `set <name> unsetLocateAP <all|_id|name|ip>`
  Stop 'locate' on one or all accesspoints.

#### Get

`Note: Some getters are not available if no data is available for them.`
- `get <name> clientData <all|user_id|controllerAlias|hostname|devAlias>`
  Show more details about clients.
- `get <name> events`
  Show events in specified 'eventPeriod'.
- `get <name> unarchivedAlerts`
  Show all unarchived Alerts.

#### Attributes

- attr devAlias
  Can be used to rename device names in the format `<user_id|controllerAlias|hostname>:Aliasname.`
  Separate using blank to rename multiple devices.
  Example (user_id):`attr unifi devAlias 5537d138e4b033c1832c5c84:iPhone-Claudiu`
  Example (controllerAlias):`attr unifi devAlias iPhoneControllerAlias:iPhone-Claudiu`
  Example (hostname):`attr unifi devAlias iphone:iPhone-Claudiu`
- attr eventPeriod <1...168>
  Can be used to configure the time-period (hours) of fetched events from controller.
  `default: 24`
- attr disable <1|0>
  With this attribute you can disable the whole module.
  If set to 1 the module will be stopped and no updates are performed.
  If set to 0 the automatic updating will performed.
- attr verbose 5
  This attribute will help you if something does not work as espected.
- attr httpLoglevel <1,2,3,4,5>
  Can be used to debug the HttpUtils-Module. Set it smaller or equal as your 'global verbose level'.
  `default: 5`
- readingFnAttributes

#### Readings

Note: All readings generate events. You can control this with these global attributes.
- Each client has 6 readings for connection-state, SNR, uptime, last_seen-time, connected-AP and hostname.
- Each AP has 3 readings for state (can be 'ok' or 'error'), essid's and count of connected-clients.
- The unifi-controller has 6 readings for event-count in configured 'timePeriod', unarchived-alert count, accesspoint count, overall wlan-state (can be 'ok', 'warning', or other?), connected user count and connected guest count.
- The Unifi-device reading 'state' represents the connection-state to the unifi-controller (can be 'connected', 'disconnected', 'initialized' and 'disabled').

### Utils

This is a collection of functions that can be used module-independant in all your own development
Defined functions

- abstime2rel("HH:MM:SS")
  tells you the difference as HH:MM:SS between now and the argument
- ltrim("string")
  returns string without leading spaces
- max(str1, str2, ...)
  returns the highest value from a given list (sorted alphanumeric)
- maxNum(num1, num2, ...)
  returns the highest value from a given list (sorted numeric)
- min(str1, str2, ...)
  returns the lowest value from a given list (sorted alphanumeric)
- minNum(num1, num2, ...)
  returns the lowest value from a given list (sorted numeric)
- rtrim("string")
  returns string without trailing spaces
- time_str2num("YYYY-MM-DD HH:MM:SS")
  convert a time string to number of seconds since 1970
- trim("string")
  returns string without leading and without trailing spaces
- UntoggleDirect("deviceName")
  For devices paired directly, converts state 'toggle' into 'on' or 'off'
- UntoggleIndirect()
  For devices paired indirectly, switches the target device 'on' or 'off', also when a 'toggle' was sent from the source device
- defInfo("devspec", "internal")
  return an array with the internal values of all devices found with devspec, e.g. defInfo("TYPE=SVG", "GPLOTFILE").
- SVG_time_to_sec("YYYY-MM-DD_HH:MM:SS")
  converts the argument to the number of seconds since 1970. Optimized for repeated use of similar timestamps.
- fhemNc("host:port", "textToSend", waitForReturn)
  sends textToSend to host:port, and if waitForReturn is set, then read the answer (wait up to 5 seconds) and return it. Intended as small nc replacement.
- round(value, digits)
  round <value> to given digits behind comma
- getUniqueId()
  return the FHEM uniqueID used by the fheminfo command. Uses the getKeyValue / setKeyValue functions.
- setKeyValue(keyName, value)
  store the value in the file $modpath/FHEM/FhemUtils/uniqueID (the name is used for backward compatibility), or in the database, if using configDB. value may not contain newlines, and only one value per key is stored. The file/database entry will be written immediately, no explicit save is required. If the value is undef, the entry will be deleted. Returns an error-string or undef.
- getKeyValue(keyName)
  return ($error, $value), stored previously by setKeyValue. $error is set if there was an error. Both are undef, if there is no value yet for this key.

### VBUSDEV

RESOL-Adapter (USB oder LAN) Info:
http://www.resol.de/
Information http://hobbyelektronik.org/w/index.php/VBus-Decoder/ or github https://github.com/pejonp/vbus
Define

`define <name> VBUSDEV <id> [<interval>]`
Connects to various RESOL VBus devices
Examples:

`define VBUSDEV_7321 VBUSDEV 7321`

Readings

- The readings are dependant of the model of the VBUS device.

### VBUSIF

This module connects to the RESOL VBUS LAN or Serial Port adapter. It serves as the "physical" counterpart to the VBUSDevice devices.
Define

`define <name> VBUS <device>`
<device> is a <host>:<port> combination, where <host> is the address of the RESOL LAN Adapter and <port> 7053.
Please note: the password of RESOL Device must be unchanged at <host>
Examples:

`define vbus VBUSIF 192.168.1.69:7053`

`define vbus VBUSIF /dev/ttyS0`

### VCONTROL

VCONTROL is a fhem-Modul to control and read information from a VIESSMANN heating via Optolink-adapter.
An Optolink-Adapter is necessary (USB or LAN), you will find information here:
http://openv.wikispaces.com/
Additionaly you need to know Memory-Adresses for the div. heating types (e.g. V200KW1, VScotHO1, VPlusHO1 ....),
that will be read by the module to get the measurements or to set the actual state.
Additional information you will find in the forum http://forum.fhem.de/index.php/topic,20280.0.html und auf der wiki Seite http://www.fhemwiki.de/wiki/Vitotronic_200_%28Viessmann_Heizungssteuerung%29
Define

`define <name> VCONTROL <serial-device/LAN-Device:port> <configfile> [<intervall>]`
- <serial-device/LAN-Device:port>
  USB Port (e.g. com4, /dev/ttyUSB3) or TCPIP:portnumber
- <intervall>
  Poll Intervall in seconds (default 180)
- <configfile>
  path to the configuration file, containing the memory addresses
Example:
serial device com4, every 3 minutes will be polled, configuration file name is 99_VCONTROL.cfg, existing in the fhem root directory
Windows:
define Heizung VCONTROL com4 99_VCONTROL.cfg 180
Linux:
define Heizung VCONTROL /dev/ttyUSB3 99_VCONTROL.cfg 180

Set

These commands will be configured in the configuartion file.

Get

get <name> CONFIG
reload the module specific configfile
More commands will be configured in the configuration file.

configfile

You will find example configuration files for the heating types V200KW1, VScotHO1, VPlusHO1 on the wiki page http://www.fhemwiki.de/wiki/Vitotronic_200_%28Viessmann_Heizungssteuerung%29.
The lines of the configuration file can have the following structure:
- lines beginning with "#" are comments!
- Polling Commands (POLL) to read values.
- Set Commands (SET) to set values.
Polling Commands have the following structure:
POLL, ADDRESSE, PARSEMETHODE, DIVISOR, READING-NAME, KUMULATION

- POLL
  is fix POLL
- ADDRESSE
  Memory Address leading to the value, the will be read in the memory on the heating.
  It is subdivided in 3 parts:
  - Beginning is fix 01F7 (defines a reading command)
  - followed by actuak address
  - followed by number of Bytes to be read.
- PARSEMETHODE
  Method how to parse the read bytes.
  methods so far:
  - 1ByteU :
    Read value is 1 Byte without algebraic sign (if column Divisor set to state -> only 0 / 1 or off / on)
  - 1ByteS :
    Read value is 1 Byte with algebraic sign (wenn Spalte Divisor state ist -> nur 0 / 1 also off / on)
  - 2ByteS :
    Read value is 2 Byte with algebraic sign
  - 2ByteU :
    Read value is 2 Byte without algebraic sign
  - 2BytePercent :
    Read value is 2 Byte in percent
  - 4Byte :
    Read value is 4 Byte
  - mode :
    Read value is the actual operating status
  - timer :
    Read value is an 8 Byte timer value
  - date :
    Read value is an 8 Byte timestamp
  POLL Commands unsing the method timer will not be polled permanent, they have to be read by a GET Commando explicitly.
  GET <devicename> TIMER
- DIVISOR
  If the parsed value is multiplied by a factor, you can configure a divisor.
  Additionally for values, that just deliver 0 or 1, you can configure state in this column.
  This will force the reading to off and on, instead of 0 and 1.
- READING-NAME
  The read and parsed value will be stored in a reading with this name in the device.
- KUMULATION
  Accumulated Day values will be automatically stored for polling commands with the value day in the column KUMULATION.
  Futhermore there will be stored the values of the last day in additional readings after 00:00.
  So you have the chance to plot daily values.
  The reading names will be supplemented by DayStart, Today and LastDay!
Examples:
`POLL, 01F7080402, 2ByteS, 10 , Temp-WarmWater-Actual , -
` `POLL, 01F7088A02, 2ByteU, 1 , BurnerStarts , day
`

Set Commands have the following structure:
SET,SETCMD, ADRESSE, CONVMETHODE, NEXT_CMD or DAY for timer

- SET
  is fix SET
- SETCMD
  SETCMD are commands that will be used in FHEM to set a value of a device
  set <devicename> <setcmd>
  e.g. SET <devicename> WW to set the actual operational status to Warm Water processing
- ADDRESSE
  Memory Address where the value has to be written in the memory of the heating.
  It is subdivided in 4 parts:
  - Beginning is fix 01F4 (defines a writing command)
  - followed by actual address
  - followed by number of data-bytes to be written
  - followed by the data-bytes themselves
  There are two Address versions:
- Version 1: Value to be set is fix, e.g. Spar Mode on is fix 01
- Version 2: Value has to be passed, e.g. warm water temperature
- CONVMETHODE
  Method how to convert the value with Version 2 in Bytes.
  For Version 1 you can use - here.
  Methods so far:
  - 1ByteU :
    Value to be written in 1 Byte without algebraic sign
    with Version 2 it has to be a number
  - 1ByteS :
    Value to be written in 1 Byte with algebraic sign
    with Version 2 it has to be a number
  - 2ByteS :
    Value to be written in 2 Byte with algebraic sign
    with Version 2 it has to be a number
  - 2ByteU :
    Value to be written in 2 Byte without algebraic sign
    with Version 2 it has to be a number
  - timer :
    Value to be written is an 8 Byte Timer value
    with Version 2 it has to be a string with this structure:
    8 times of day comma separeted. (ON1,OFF1,ON2,OFF2,ON3,OFF3,ON4,OFF4)
    no time needed ha to be specified with -- .
    Minutes of the times are just allowed to thi values: 00,10,20,30,40 or 50
    Example: 06:10,12:00,16:00,23:00,--,--,--,--
  - date :
    Value to be written is an 8 Byte timestamp
    with Version 2 it has to be a string with this structure:
    format specified is DD.MM.YYYY_HH:MM:SS
    Example: 21.03.2014_21:35:00
- NEXT_CMD or DAY
  This column has three functions:
  - If this columns is configured with a name of another SETCMD, it will be processed directly afterwards.
    Example: after setting Spar Mode on (S-ON), you have to set Party Mode off (P-OFF)
  - Using a CONVMETHODE 1ByteU or 1ByteS or 2ByteS or 2ByteU , you can use the column as an multiplicator,
    which will be multiplied to the value in the SET command
    Example: `SET, TEMPNHK1 , 01F4200002 , 2ByteU , 10` With `SET DEVICE TEMPNHK1 21` 210 will be send to the heating.
  - Using timer as CONVMETHODE, so it has to be specified a week day in this columns.
    possible values: MO DI MI DO FR SA SO

Examples:
`SET, WW , 01F423010100, state , -
` `SET, S-ON , 01F423020101, state_spar , P-OFF
` `SET, WWTEMP , 01F4630001 , 1ByteU , -
` `SET, TIMER_2_MO, 01F4200008 , timer , MO
`

Readings

The values read will be stored in readings, that will be configured as described above.

### VIERA

Define

`define <name> VIERA <host> [<interval>]`
This module controls Panasonic TV device over ethernet. It's possible to power down the tv, change volume or mute/unmute the TV. Also this modul is simulating the remote control and you are able to send different command buttons actions of remote control. The module is tested with Panasonic plasma TV tx-p50vt30e
Defining a VIERA device will schedule an internal task (interval can be set with optional parameter <interval> in seconds, if not set, the value is 30 seconds), which periodically reads the status of volume and mute status and triggers notify/filelog commands.
Notes:

Activate volume remotecontrol by DLNA: Menu -> Setup -> Network Setup -> Network Link Settings -> DLNA RemoteVolume -> On

Example:

`define myTV1 VIERA 192.168.178.20
define myTV1 VIERA 192.168.178.20 60 #with custom interval of 60 seconds`

Set

`set <name> <command> [<value>]`
Currently, the following commands are defined.

`off
mute [on|off]
volume [0-100]
volumeUp
volumeDown
channel [1-9999]
channelUp
channelDown
statusRequest
remoteControl <command>
input [hdmi1|hdmi2|hdmi3|hdmi4|sdCard|tv]
`

Remote control (depending on your model, maybe)
For this application the following commands are available:

`3D => 3D button
BLUE => Blue
CANCEL => Cancel / Exit
CHG_INPUT => AV
CH_DOWN => Channel down
CH_UP => Channel up
D0 => Digit 0
D1 => Digit 1
D2 => Digit 2
D3 => Digit 3
D4 => Digit 4
D5 => Digit 5
D6 => Digit 6
D7 => Digit 7
D8 => Digit 8
D9 => Digit 9
DISP_MODE => Display mode / Aspect ratio
DOWN => Control DOWN
ENTER => Control Center click / enter
EPG => Guide / EPG
FF => Fast forward
GREEN => Green
HOLD => TTV hold / image freeze
INDEX => TTV index
INFO => Info
INTERNET => VIERA connect
LEFT => Control LEFT
MENU => Menu
MUTE => Mute
PAUSE => Pause
PLAY => Play
POWER => Power off
P_NR => P-NR (Noise reduction)
REC => Record
RED => Red
RETURN => Return
REW => Rewind
RIGHT => Control RIGHT
R_TUNE => Seems to do the same as INFO
SD_CARD => SD-card
SKIP_NEXT => Skip next
SKIP_PREV => Skip previous
STOP => Stop
STTL => STTL / Subtitles
SUBMENU => Option
TEXT => Text / TTV
TV => TV
UP => Control UP
VIERA_LINK => VIERA link
VOLDOWN => Volume down
VOLUP => Volume up
VTOOLS => VIERA tools
YELLOW => Yellow
`

Example:

`set <name> mute on
set <name> volume 20
set <name> remoteControl CH_DOWN
`

Get

`get <name> <what>`
Currently, the following commands are defined and return the current state of the TV.

`mute
volume
power
presence
`

Attributes

blocking [0|1]

Generated events:

- volume
- mute
- presence
- power
- state

### VantagePro2

Note: this module needs the Net::Telnet perl module.
Define

`define <name> <ip-address> <port> <delay>`
Defines a Davis VantagePro2 weatherstation attached on transparent ethernet/usb|serial server accessable by telnet.
Examples:

`define AUSSEN.wetterstation VantagePro2 192.168.8.127 4999 60`
`fhem> list AUSSEN.wetterstation
Internals:
DEF 192.168.8.127 4999 60
Host 192.168.8.127
NAME AUSSEN.wetterstation
NR 5
Port 4999
STATE T-OUT: 22.78 T-IN: 26.50 H-OUT: 55 H-IN: 45 W: 1.61 W-AV: 1.61 WS 257 R: 0.00 S: 770 UV: 4.1 RD: 0 RM: 41 RY: 241 BM: 76.27 BT: Steady
TYPE VantagePro2
Readings:
2010-08-04 10:15:17 10 min. average windspeed 1.61 (km/h)
2010-08-04 10:15:17 UV 4.1 (UV/Index)
2010-08-04 10:15:17 barometer 76.27 (Millimeters)
2010-08-04 10:15:17 barometer trend Steady
2010-08-04 10:15:17 day rain 0 (mm/day)
2010-08-04 10:15:17 humidity inside 45 (%)
2010-08-04 10:15:17 humidity outside 55 (%)
2010-08-04 10:15:17 month rain 41 (mm/month)
2010-08-04 10:15:17 rainrate 0.00 (mm/h)
2010-08-04 10:15:17 solar 770 (Watt/m^2)
2010-08-04 10:15:17 temperature-inside 26.50 (Celsius)
2010-08-04 10:15:17 temperature-outside 22.78 (Celsius)
2010-08-04 10:15:17 wind direction 257 (Degrees)
2010-08-04 10:15:17 windspeed 1.61 (km/h)
2010-08-04 10:15:17 year rain 241 (mm/year)
Attributes:
delay 60
`

### Verkehrsinfo

Verkehrsinfo can read trafficinformation from various source.

- Verkehrsinfo.de
For receiving the traffic informationen, following website https://www.verkehrsinfo.de/httpsmobil will be called on.
There you can select streets or federal states. Afterwards the URL will be committed as a parameter.
- Hessenschau.de
Here is no configuration necessary, the URL http://hessenschau.de/verkehr/index.html will be used as a parameter.
- RadioSAW.de
Here is no configuration necessary, the keyword radiosaw will be used as a parameter.

Requirement:

For this module, following perl-modules are required:
- HTML::TreeBuilder::XPath
  `sudo apt-get install libxml-treebuilder-perl libhtml-treebuilder-xpath-perl`

Define

`define <name> Verkehrsinfo <url> <interval>`
example: `define A8 Verkehrsinfo https://www.verkehrsinfo.de/httpsmobil/index.php?c=staulist&street=A8&lat=&lon= 3600`
Options:

- url
  URL regarding the traffic information
- interval
  How often the data will be updated in seconds

Set

`set <name> <option>`
Options:

- update
  update will be executed right away

Get

`get <name> <option>`
Options:

- info
  output currently traffic information

Attributes

`attr <name> <option> <value>`
Options:

- filter_exclude
  This is an exclusion filter. Traffic information containing these words, will not be displayed.
  The filter supports regular expressions. Attention: regex control character, for example brackets have to be masked with a backslash "\".
  Multiple searching keywords can be seperated with the pipe "|".
- filter_include
  This is an inclusion filter. Traffic information containing these words, will be displayed.
  The filter supports regular expressions. Attention: regex control character, for example brackets have to be masked with a backslash "\".
  Multiple searching keywords can be seperated with the pipe "|".
- Hint: Both filters can be used at the same time, or optional just one.
  The filters are linked with a logical and. That means, for example, when something is excluded, it can be reincluded with the other filter.
- orderby
  Messages will be sorted by relevance by reference to the string.
  The sort supports regular expressions.
  Multiple searching keywords can be seperated with the pipe "|".
- msg_format [ road | head | both ] (only Verkehrsinfo.de and RadioSAW.de)
  Using this parameter you can format the output, regarding streets, direction or both.
- readingFnAttributes

Readings

- e_0|1|2|3...|9_... - aktiv message
- count - number of aktiv messages
- e_0_road - street
- e_0_head - direction
- e_0_msg - message

Funktion

`Verkehrsinfo_GetData(<devicename>)`
The function can be accessed anywhere in FHEM. The output of this function is the same as get <name> info and the string can be used for further forwarding.
example: `my $result = Verkehrsinfo_GetData('A8')`

### VolumeLink

VolumeLink links the volume-level & mute-state from a physical device (e.g. a Philips-TV) with the volume & mute control of a fhem device (e.g. a SONOS-Playbar, Onkyo, Yamaha or Denon Receiver, etc.).

#### Define

`define <name> VolumeLink <interval> <url> <ampDevice> [<timeout> [<httpErrorLoglevel> [<httpLoglevel>]]]`
<interval>:

`interval to fetch current volume & mute level from physical-device.`

<url>:

`url to fetch volume & mute level, see Example below. (Example applies to many Philips TV's)`

<ampDevice>:

`the target fhem-device.`

[<timeout>]:

`optional: timeout of a http-get. default: 0.5 seconds`

[<httpErrorLoglevel>]:

`optional: loglevel of http-errors. default: 4`

[<httpLoglevel>]:

`optional: loglevel of http-messages. default: 5`

#### Example

`define tvVolume_LivingRoom VolumeLink 0.2 http://192.168.1.156:1925/5/audio/volume Sonos_LivingRoom`
`set tvVolume_LivingRoom on`
Note:
- This example will work out of the box with many Philips TV's and a SONOS-Playbar as fhem-device.
- Pre 2014 Philips TV's use another protocoll, which can be accessed on http://<ip>/1/audio/volume

#### Set

`set <name> <on|off>`
Set on or off, to start or to stop.

#### Get

N/A

#### Attributes

Note:
- All Attributes takes effect immediately.
- The default value of volumeRegexPattern & muteRegexPattern applies to many Philips-TV's, otherwise it must be configured.
- The default values of amp* applies to a SONOS-Playbar, otherwise it must be configured.
- If you don't receive a result from url, or the lastHttpErrorMessage shows every time 'timed out', try setting attribute 'httpNoShutdown' to 0.
- disable <1|0>
  With this attribute you can disable the whole module.
  If set to 1 the module will be stopped and no volume will be fetched from physical-device or transfer to the amplifier-device.
  If set to 0 you can start the module again with: set <name> on.
- httpNoShutdown <1|0>
  If set to 0 VolumeLink will tell the http-server to explicit close the connection.
  Default: 1
- ampInputReading <value>
  Name of the Input-Reading on amplifier-device
  To disable the InputCheck if your amplifier-device does not support this, set this attribute to 0.
  Default (which applies to SONOS-Player's): currentTitle
- ampInputReadingVal <RegEx>
  RegEx for the Reading value of the corresponding Input-Channel on amplifier-device
  Default (which applies to a SONOS-Playbar's SPDIF-Input and if no Input is selected): SPDIF-Wiedergabe|^$
- ampVolumeReading <value>
  Name of the Volume-Reading on amplifier-device
  Default: Volume
- ampVolumeCommand <value>
  Command to set the volume on amplifier device
  Default: Volume
- ampMuteReading <value>
  Name of the Mute-Reading on amplifier-device
  Default: Mute
- ampMuteReadingOnVal <value>
  Reading value if muted
  Default: 1
- ampMuteReadingOffVal <value>
  Reading value if not muted
  Default: 0
- ampMuteCommand <value>
  Command to mute the amplifier device
  Default: Mute
- volumeRegexPattern <RegEx>
  RegEx which is applied to url return data. Must return a number for volume-level.
  Default (which applies to many Phlips-TV's): current":\s*(\d+)
- muteRegexPattern <RegEx>
  RegEx which is applied to url return data. Must return true, false, 1 or 0 as mute-state.
  Default (which applies to many Phlips-TV's): muted":\s*(\w+|\d+)

#### Readings

Note: All VolumeLink Readings except of 'state' does not generate events!
- lastHttpError
  The last HTTP-Error will be recorded in this reading.
  Define httpErrorLoglevel, httpLoglevel or attribute verbose for more information.
  Note: Attr verbose will not output all HTTP-Messages, define httpLoglevel for this.
- mute
  The current mute-state fetched from physical device.
- volume
  The current volume-level fetched from physical device.
- state
  on if VolumeLink is running, off if VolumeLink is stopped.

### WEBCOUNT

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

`define <name> WEBCOUNT <ip-address> <port> <delay>`
Defines an WEBCOUNT device (Box with 6 count pulses, www.wut.de) via ip address. The device is pooled (delay interval).
Examples:

`define pump WEBCOUNT 192.168.8.200 1 60`

### WEBIO

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

`define <name> WEBIO <ip-address> <port> <delay>`
Defines an Web-IO device (Box with 2 Analog-In/Out 0..10V, www.wut.de) via ip address. The status of the device is also pooled (delay interval).
Examples:

`define pumpspeed WEBIO 192.168.8.200 1 60`

Set

`set <name> <value>`
where `value` is one of:

        0.00 - 10.00

Examples:

`set pumpspeed 6.75`

### WEBIO_12DIGITAL

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

`define <name> WEBIO_12DIGITAL <ip-address> <outputport> <delay>`
Defines an Web-IO-Digital device (Box with up to 12 digital in/outputs, www.wut.de) via ip address. The status of the device is also pooled (delay interval).
Examples:

`define motor1 WEBIO_12DIGITAL 192.168.8.200 1 60`

Set

`set <name> <value>`
where `value` is one of:

           on off

Examples:

`set motor1 on`

### WMBUS - Wireless M-Bus

This module supports Wireless M-Bus meters for e.g. water, heat, gas or electricity. Wireless M-Bus is a standard protocol supported by various manufacturers. It uses the 868 MHz band for radio transmissions. Therefore you need a device which can receive Wireless M-Bus messages, e.g. a CUL with culfw >= 1.59 or an AMBER Wireless AMB8465M.
WMBus uses two different radio protocols, T-Mode and S-Mode. The receiver must be configured to use the same protocol as the sender. In case of a CUL this can be done by setting rfmode to WMBus_T or WMBus_S respectively.
WMBus devices send data periodically depending on their configuration. It can take days between individual messages or they might be sent every minute.
WMBus messages can be optionally encrypted. In that case the matching AESkey must be specified with attr AESkey. Otherwise the decryption will fail and no relevant data will be available.
Prerequisites
This module requires the perl modules Crypt::CBC, Digest::CRC and Crypt::OpenSSL::AES (AES only if encrypted messages should be processed).
On a debian based system these can be installed with
`sudo apt-get install libcrypt-cbc-perl libdigest-crc-perl libssl-dev
sudo cpan -i Crypt::OpenSSL::AES`
Define

`define <name> WMBUS [<manufacturer id> <identification number> <version> <type> [<MessageEncoding>]]|<bHexCode>`
Normally a WMBus device isn't defined manually but automatically through the autocreate mechanism upon the first reception of a message.
For a manual definition there are two ways.

- By specifying a raw WMBus message as received by a CUL. Such a message starts with a lower case 'b' and contains at least 24 hexadecimal digits. The WMBUS module extracts all relevant information from such a message.
- Explictly specify the information that uniquely identifies a WMBus device.
  The manufacturer code, which is is a three letter shortcut of the manufacturer name. See dlms.com for a list of registered ids.
  The identification number is the serial no of the meter.
  version is the version code of the meter
  type is the type of the meter, e.g. water or electricity encoded as a number.
  MessageEncoding is either CUL or AMB, depending on which kind of IODev is used.

Set

N/A

Get

N/A

Attributes

- IODev
  Set the IO or physical device which should be used for receiving signals for this "logical" device. An example for the physical device is a CUL.
- AESKey
  A 16 byte AES-Key in hexadecimal digits. Used to decrypt messages from meters which have encryption enabled.
- ignore
- rawmsg_as_reading
  If set to 1, received raw messages will be stored in the reading rawmsg. This can be used to log raw messages to help with debugging.

Readings

Meters can send a lot of different information depending on their type. An electricity meter will send other data than a water meter. The information also depends on the manufacturer of the meter. See the WMBus specification on oms-group.org for details.
The readings are generated in blocks starting with block 1. A meter can send several data blocks. Each block has at least a type, a value and a unit, e.g. for an electricity meter it might look like

`1_type VIF_ENERGY_WATT`
`1_unit Wh`
`1_value 2948787`

There is also a fixed set of readings.

- `is_encrypted` is 1 if the received message is encrypted.
- `decryption_ok` is 1 if a message has either been successfully decrypted or if it is unencrypted.
- `state` contains the state of the meter and may contain error message like battery low. Normally it contains 'no error'.
- `battery` contains ok or low.

For some well known devices specific readings like the energy consumption in kWh created.

### WOL

Defines a WOL device via its MAC and IP address.
when sending the on command to a WOL device it wakes up the dependent device by sending a magic packet. When running in repeat mode the magic paket ist sent every n seconds to the device. So, for example a Buffalo NAS can be kept awake.

#### Define

`define <name> WOL <MAC> <IP> [<mode> [<repeat>]]`

MAC
  MAC-Adress of the host
IP
  IP-Adress of the host (or broadcast address of the local network if IP of the host is unknown)
mode [EW|UDP]
  EW: wakeup by usr/bin/ether-wake
  UDP: wakeup by an implementation like Net::Wake(CPAN)

Examples:

`define computer1 WOL 72:11:AC:4D:37:13 192.168.0.24 switching only one time`
`define computer1 WOL 72:11:AC:4D:37:13 192.168.0.24 EW by ether-wake(linux command)`
`define computer1 WOL 72:11:AC:4D:37:13 192.168.0.24 BOTH by both methods`
`define computer1 WOL 72:11:AC:4D:37:13 192.168.0.24 UDP 200 in repeat modeusr/bin/ether-wake in repeatmode`

Notes:

Not every hardware is able to wake up other devices by default. Oftenly firewalls filter magic packets. Switch them first off. You may need a packet sniffer to check some malfunktion. With this module you get two methods to do the job: see the mode parameter.

#### Set

`set <name> <value>`
where `value` is one of:

        refresh           # checks(by ping) whether the device is currently running
        on                # sends a magic packet to the defined MAC address
        off               # stops sending magic packets and sends the shutdownCmd(see attributes)

Examples:

`set computer1 on`
`set computer1 off`
`set computer1 refresh`

#### Attributes

- `attr <name> sysCmd <string>`
  Custom command executed to wakeup a remote machine, i.e. `/usr/bin/ether-wake or /usr/bin/wakeonlan`
- `attr <name> shutdownCmd <command>`
  Custom command executed to shutdown a remote machine. You can use <command>, like you use it in at, notify or Watchdog
Examples:

        attr wol shutdownCmd    set lamp on                            # fhem command
        attr wol shutdownCmd    { Log 1, "Teatime" }                   # Perl command
        attr wol shutdownCmd    "/bin/echo "Teatime" > /dev/console"   # shell command

- `attr <name> interval <seconds>`
  defines the time between two checks by a ping if state of <name> is on. By using 0 as parameter for interval you can switch off checking the device.
- `attr <name> useUdpBroadcast <broardcastAdress>`
  When using UDP then the magic packet can be send to one of the broardcastAdresses (x.x.x.255, x.x.255.255, x.255.255.255) instead of the target host address. Try using this, when you want to wake up a machine in your own subnet and the wakekup with the target adress is instable or doesn't work.

### WS2000

Define

`define <name> WS2000 <device_to_connect>`
Define a WS2000 series raw receiver device sold by ELV. Details see here. Unlike 86_FS10.pm it will handle the complete device communication itself and doesnt require an external program. For this reason you can now use this also on windows.
This Device will be usually connect to a serial port, but you can also define a raw network redirector like lantronix XPORT(TM).
Note: Currently this device does not support a "set" function
Attributes:

- `rain`: factor for calculating amount of rain in ml/count
- `altitude`: height in meters to calculate pressure for NN (not used yet)

Example:

`define WS2000 WS2000 /dev/ttyS0`

`define WS2000 WS2000 xport:10001`

`attr WS2000 rain 366` : use factor 366 ml/count for rain sensor S2000R

Set

N/A

Get

`get <name> list`
Gets the last reading of all received sensord
`get <name> [TH0..TH7, T0..T7, I0..I7, R0..R7, W0..W7, L0..L7, P0..P7,LAST,RAW]`
get the last reading for the name sensor,
`LAST`: Last received Sensor
`RAW`: original Data from interface

Attributes

- model (ws2000)
- loglevel
- rain
- altitude

### WS300

Define

`define WS300Device WS300 <serial device>`
or
`define <devname> WS300 [0-9]`
The first line is mandatory if you have a WS300 device: it defines the input device with its USB port. The name of this device is fixed and must be WS300Device. It must be the first defined WS300 device.
For each additional device (with number 0 to 9) you have to define another WS300 device, with an arbitrary name. The WS300 device which reports the readings will be defined with the port number 9, an optional KS300 with the port number 8.
Examples:

          define WS300Device  WS300   /dev/ttyUSB1
          define ash2200.1    WS300   0
          define ks300        WS300   8
          define ws300        WS300   9

Set

`set WS300Device <interval(min.)> <height(m)> <rainvalume(ml)>`
Set some WS300 configuration parameters.

Get

N/A

Attributes

- do_not_notify
- model (ws300)
- readingFnAttributes

### WS3600

Defines a weather station, which is queried by means of an external program. That program is executed by FHEM and is expected to deliver the data at stdout in the format of a WS3600 series weather station (details see below).
Define

`define <name> WS3600 "<wsreaderprog> [<options>]" [<interval>]`

<wsreaderprog>
  full path to the executable which queries the weatherstation (for WS3600 series fetch3600 should be used)
<options>
  options for <wsreaderprog>, if necessary
<interval>
  this optional parameter is the time between subsequent calls to <wsreaderprog>. It defaults to 60s.

Supported Stations are:

- WS3600 series weather station (Europe Supplies, technotrade, etc; refer to Wetterstationen.info (german) for details on this model) with fetch3600 from the toolchain open3600). Fetch3600 delivers the current readings line by line as reading-value-pairs. These are read periodically and translated into more readable names for FHEM by the module WS3600.pm.
- WS2300 with toolchain open2300, because it is rather similar to the WS3600.
- WS1080 (and other stations which come with the EasyWeather windows application) with fowsr (version 2.0 or above)

Currently, it is expected that the WS is attached to the local computer and <wsreaderprog> is run locally. Basically the executable called needs to supply on stdout an output similar to what fetch3600 returns; how to implement a "networked setup" is left as an excercise to the reader.
For the records, this is an output of fetch3600:

    Date 14-Nov-2009
    Time 10:50:22
    Ti 22.8
    Timin 20.8
    Timax 27.9
    TTimin 10:27
    DTimin 15-10-2009
    TTimax 23:31
    DTimax 20-08-2009
    To 14.2
    Tomin -0.4
    Tomax 35.6
    TTomin 07:03
    DTomin 15-10-2009
    TTomax 16:52
    DTomax 20-08-2009
    DP 9.2
    DPmin -2.2
    DPmax 20.3
    TDPmin 07:03
    DDPmin 15-10-2009
    TDPmax 11:58
    DDPmax 20-08-2009
    RHi 48
    RHimin 32
    RHimax 57
    TRHimin 17:03
    DRHimin 21-10-2009
    TRHimax 22:24
    DRHimax 07-10-2009
    RHo 72
    RHomin 27
    RHomax 96
    TRHomin 16:41
    DRHomin 20-08-2009
    TRHomax 06:28
    DRHomax 02-11-2009
    WS 0.0
    DIRtext WSW
    DIR0 247.5
    DIR1 247.5
    DIR2 247.5
    DIR3 247.5
    DIR4 247.5
    DIR5 247.5
    WC 14.2
    WCmin -0.4
    WCmax 35.6
    TWCmin 07:03
    DWCmin 15-10-2009
    TWCmax 16:52
    DWCmax 20-08-2009
    WSmin 0.0
    WSmax 25.6
    TWSmin 10:44
    DWSmin 14-11-2009
    TWSmax 19:08
    DWSmax 24-09-2009
    R1h 0.00
    R1hmax 24.34
    TR1hmax 22:34
    DR1hmax 07-10-2009
    R24h 0.00
    R24hmax 55.42
    TR24hmax 07:11
    DR24hmax 08-10-2009
    R1w 29.00
    R1wmax 95.83
    TR1wmax 00:00
    DR1wmax 12-10-2009
    R1m 117.58
    R1mmax 117.58
    TR1mmax 00:00
    DR1mmax 01-11-2009
    Rtot 3028.70
    TRtot 03:29
    DRtot 18-09-2005
    RP 992.200
    AP 995.900
    RPmin 970.300
    RPmax 1020.000
    TRPmin 05:25
    DRPmin 04-11-2009
    TRPmax 09:19
    DRPmax 11-09-2009
    Tendency Falling
    Forecast Cloudy

There is no expectation on the readings received from the fetch3600 binary; so, in essence, if you have a similar setup (unsupported, attached weather station and a means to get it's reading into an output similar to above's), you should be able to use WS3600.pm with a custom written script to interface FHEM with your station as well. WS3600.pm only recognizes the above readings (and translates these into, e. g., `Temp-inside` for `Ti` for use within FHEM), other lines are silently dropped on the floor. Note: To step down the number of readings date and time records will now be merged to one reading containing date and time. This now also allows records with merged date / time values delivered from <wsreaderprog> - detected by prefix `DT` (e.g. `Date` + `Time` --> `DTime`, `DRPmin` + `TRPmin` --> `DTRPmin` and so on).
fetch3600 is available as binary for the Windows OS as well, but operation under that OS isn't tested yet.
Examples:

`define myWS3600 W3600 /usr/local/bin/fetch360`
`define myWS1080 W3600 "/usr/local/bin/fowsr -c" 300`

Set

N/A

Get

N/A

Attributes

- model WS3600, WS2300, WS1080 (not used for anything, yet)

### WWO

Define

`define <name> WWO <location> <apikey>`
Defines a virtual device for WWO forecasts.
A WWO device periodically gathers current and forecast weather conditions from worldweatheronline.com (the free api version)
You need to signup at http://developer.worldweatheronline.com to get an apikey)
The parameter `location` is the WOEID (WHERE-ON-EARTH-ID), go to http://www.worldweatheronline.com to find it out for your valid location.
The natural language in which the forecast information appears is english.
The interval is set to update the values every hour.
Examples:

          define MyWeather WWO Berlin,Germany

The module provides one additional function `WWOAsHtml`. The function return the HTML code for a vertically arranged weather forecast.
Example:

          define MyWeatherWeblink weblink htmlCode { WWOAsHtml("MyWeather") }

Set

`set <name> update`
Forces the retrieval of the weather data. The next automatic retrieval is scheduled to occur `interval` seconds later.

Get

`get <name> <reading>`
Valid readings and their meaning (? can be one of 0, 1, 2, 3, 4, 5 and stands for today, tomorrow, etc. - with 'fc?_' or without! - without is meaning 'current condition'):

cloudcover | cloudcover in percent
current_date_time | last update of forecast on server
fc?_date | date of the forecast condition - not valid without 'fc?'
fc?_icon | name of the forecasticon
fc?_precipMM | preciption for day
fc?_tempMaxC | forecasted daily high in degrees centigrade
fc?_tempMaxF | forecasted daily high in degrees fahrenheit
fc?_tempMinC | forecasted daily low in degrees centigrade
fc?_tempMinF | forecasted daily low in degrees fahrenheit
fc?_weatherCode | weathercode
fc?_weatherDesc | short weather desciption
fc?_weatherIconUrl | full url to the weathericonfile
fc?_winddir16Point | winddirection with 16 points
fc?_winddirDegree | windirection in degrees
fc?_winddirection | winddirection
fc?_windspeedKmph | windspeed in km/h
fc?_windspeedMiles | windspeed in miles/h
humidity | current humidity in %
localObsDateTime | local time of observation
observation_time | time of observation
pressure | air pressure in hPa
query | returns the queried location
temperature | current temperature in degrees centigrade
visibility | current visibilit in km

Attributes

- readingFnAttributes

### Weather

You need the JSON perl module. Use `apt-get install libjson-perl` on Debian and derivatives.
Define

`define <name> Weather <location> [<interval> [<language>]]`
Defines a virtual device for weather forecasts.
A Weather device periodically gathers current and forecast weather conditions from the Yahoo Weather API.
The parameter `location` is the WOEID (WHERE-ON-EARTH-ID), go to http://weather.yahoo.com to find it out for your location.
The optional parameter `interval` is the time between subsequent updates in seconds. It defaults to 3600 (1 hour).
The optional language parameter may be one of `de`, `en`, `pl`, `fr`, `nl`, It determines the natural language in which the forecast information appears. It defaults to `en`. If you want to set the language you also have to set the interval.
Examples:

          define MyWeather Weather 673513
          define Forecast Weather 673513 1800

The module provides four additional functions `WeatherAsHtml`, `WeatherAsHtmlV`, `WeatherAsHtmlH` and `WeatherAsHtmlD`. The former two functions are identical: they return the HTML code for a vertically arranged weather forecast. The third function returns the HTML code for a horizontally arranged weather forecast. The latter function dynamically picks the orientation depending on wether a smallscreen style is set (vertical layout) or not (horizontal layout). Each version accepts an additional paramter to limit the numer of icons to display.
Example:

          define MyWeatherWeblink weblink htmlCode { WeatherAsHtmlH("MyWeather") }

Set

`set <name> update`
Forces the retrieval of the weather data. The next automatic retrieval is scheduled to occur `interval` seconds later.

Get

`get <name> <reading>`
Valid readings and their meaning (? can be one of 1, 2, 3, 4, 5 and stands for today, tomorrow, etc.):

city | name of town returned for location
code | current condition code
condition | current condition
current_date_time | last update of forecast on server
fc?_code | forecast condition code
fc?_condition | forecast condition
fc?_day_of_week | day of week for day +?
fc?_high_c | forecasted daily high in degrees centigrade
fc?_icon | forecast icon
fc?_low_c | forecasted daily low in degrees centigrade
humidity | current humidity in %
icon | relative path for current icon
pressure | air pressure in hPa
pressure_trend | air pressure trend (0= steady, 1= rising, 2= falling)
pressure_trend_txt | textual representation of air pressure trend
pressure_trend_sym | symbolic representation of air pressure trend
temperature | current temperature in degrees centigrade
temp_c | current temperature in degrees centigrade
temp_f | current temperature in degrees Fahrenheit
visibility | visibility in km
wind | wind speed in km/h
wind_chill | wind chill in degrees centigrade
wind_condition | wind direction and speed
wind_direction | direction wind comes from in degrees (0 = north wind)
wind_speed | same as wind

The following readings help to identify whether a workaround has kicked in to avoid the retrieval of stale data from the remote server:

pubDate | publication time of forecast for current set of readings
pubDateRemote | publication time of forecast as seen on remote server
validity | stale, if publication time as seen on remote server is before that of current set of readings

Attributes

- disable: disables the retrieval of weather data - the timer runs according to schedule, though no data is requested from the API.
- readingFnAttributes

### WeekdayTimer

Define

`define <name> WeekdayTimer <device> [<language>] [weekdays] <profile> <command>|<condition>`
to set a weekly profile for <device>
You can define different switchingtimes for every day.
The new parameter is sent to the <device> automatically with
`set <device> <para>`
If you have defined a <condition> and this condition is false if the switchingtime has reached, no command will executed.
An other case is to define an own perl command with <command>.

The following parameter are defined:

device
The device to switch at the given time.

language
Specifies the language used for definition and profiles. de,en,fr are possible. The parameter is optional.

weekdays
Specifies the days for all timer in the WeekdayTimer. The parameter is optional. For details see the weekdays part in profile.

profile
Define the weekly profile. All timings are separated by space. A switchingtime is defined by the following example:

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

weekdays: optional, if not set every day of the week is used.
Otherwise you can define a day with its number or its shortname.

- 0,su sunday
- 1,mo monday
- 2,tu tuesday
- 3,we wednesday
- 4 ...
- 7,$we weekend ($we)
- 8,!$we weekday (!$we)

It is possible to define $we or !$we in daylist to easily allow weekend an holiday. $we !$we are coded as 7 8, when using a numeric daylist.
time:define the time to switch, format: HH:MM:[SS](HH in 24 hour format) or a Perlfunction like {sunrise_abs()}. Within the {} you can use the variable $date(epoch) to get the exact switchingtimes of the week. Example: {sunrise_abs_dat($date)}
parameter:the parameter to be set, using any text value like on, off, dim30%, eco or comfort - whatever your device understands.

command
If no condition is set, all the rest is interpreted as a command. Perl-code is setting up by the well-known Block with {}.
Note: if a command is defined only this command is executed. In case of executing a "set desired-temp" command, you must define the hole commandpart explicitly by yourself.
The following parameter are replaced:

1. $NAME => the device to switch
2. $EVENT => the new temperature

condition
if a condition is defined you must declare this with () and a valid perl-code.
The return value must be boolean.
The parameters $NAME and $EVENT will be interpreted.

Examples:

`define shutter WeekdayTimer bath 12345|05:20|up 12345|20:30|down`
Mo-Fr are setting the shutter at 05:20 to up, and at 20:30 down.

`define heatingBath WeekdayTimer bath 07:00|16 Mo,Tu,Th-Fr|16:00|18.5 20:00|eco {fhem("set dummy on"); fhem("set $NAME desired-temp $EVENT");}`
At the given times and weekdays only(!) the command will be executed.

`define dimmer WeekdayTimer livingRoom Sa-Su,We|07:00|dim30% Sa-Su,We|21:00|dim90% (ReadingsVal("WeAreThere", "state", "no") eq "yes")`
The dimmer is only set to dimXX% if the dummy variable WeAreThere is "yes"(not a real live example).

If you want to have set all WeekdayTimer their current value (after a temperature lowering phase holidays) you can call the function WeekdayTimer_SetParm("WD-device") or WeekdayTimer_SetAllParms().
This call can be automatically coupled to a dummy by a notify:
`define dummyNotify notify Dummy:. * {WeekdayTimer_SetAllTemps()}`

Some definitions without comment: ``

            define wd    Weekdaytimer  device de         7|23:35|25        34|23:30|22 23:30|16 23:15|22     8|23:45|16
            define wd    Weekdaytimer  device de         fr,$we|23:35|25   34|23:30|22 23:30|16 23:15|22    12|23:45|16
            define wd    Weekdaytimer  device de         20:35|25          34|14:30|22 21:30|16 21:15|22    12|23:00|16

            define wd    Weekdaytimer  device de         mo-so, $we|{sunrise_abs_dat($date)}|on       mo-so, $we|{sunset_abs_dat($date)}|off
            define wd    Weekdaytimer  device de         mo-so,!$we|{sunrise_abs_dat($date)}|aus      mo-so,!$we|{sunset_abs_dat($date)}|aus

            define wd    Weekdaytimer  device de         {sunrise_abs_dat($date)}|19           {sunset_abs_dat($date)}|21
            define wd    Weekdaytimer  device de         22:35|25  23:00|16

The daylist can be given globaly for the whole Weekdaytimer:

``

            define wd    Weekdaytimer device de  !$we     09:00|19  (function("Ein"))
            define wd    Weekdaytimer device de   $we     09:00|19  (function("Ein"))
            define wd    Weekdaytimer device de   78      09:00|19  (function("exit"))
            define wd    Weekdaytimer device de   57      09:00|19  (function("exit"))
            define wd    Weekdaytimer device de  fr,$we   09:00|19  (function("exit"))

Set `set <name> <value>`
where `value` is one of:

        disable               # disables the Weekday_Timer
        enable                # enables  the Weekday_Timer

Examples:

`set wd disable`
`set wd enable`

Get

N/A

Attributes

- delayedExecutionCond
  defines a delay Function. When returning true, the switching of the device is delayed until the function retruns a false value. The behavior is just like a windowsensor in Heating_Control.
  Example:

          attr wd delayedExecutionCond isDelayed("$HEATING_CONTROL","$WEEKDAYTIMER","$TIME","$NAME","$EVENT")

  the parameter $WEEKDAYTIMER(timer name) $TIME $NAME(device name) $EVENT are replaced at runtime by the correct value.
  Example of a function:

          sub isDelayed($$$$$) {
             my($hc, $wdt, $tim, $nam, $event ) = @_;

             my $theSunIsStillshining = ...

             return ($tim eq "16:30" && $theSunIsStillshining) ;
          }

- switchInThePast
  defines that the depending device will be switched in the past in definition and startup phase when the device is not recognized as a heating. Heatings are always switched in the past.
- disable
- loglevel
- event-on-update-reading
- event-on-change-reading
- stateFormat

### WifiLight

The module controls a large number of different "no name" LED types and provide a consistent interface.

Following types will be supported:

type / bridge | type | note | define signature
--- | --- | --- | ---
Milight RGB first generation | E27, stripe controller | *(1,2,a,C) | RGB bridge-V2|3
Milight RGBW1 first generation | RGBW stripe controller | *(1,2,a) | RGBW1 bridge-V2|3
Milight Dual White | E14, E27, GU10, stripe controller, Downlight | *(1,2,b,W,nK) | White bridge-V2|3
Milight RGBW2 second generation | E14, E27, GU10, stripe controller, Downlight | *(2,b,CW,S20) | RGBW2 bridge-V3
LW12 first generation (SSID LEDNet...) | RGB stripe controller |  | RGB LW12
LW12HX (SSID HX...) | RGB stripe controller |  | RGB LW12HX
LW12FC (SSID FC...) | RGB stripe controller |  | RGB LW12FC
LD316 in RGB mode | E27 |  | RGB LD316
LD316 in RGBW mode | E27 | *(S20) | RGBW LD316
LD316A in RGBW mode | E27 | *(S20) | RGBW LD316A
LD382 in RGB mode | RGB stripe controller |  | RGB LD382
LD382 in RGBW mode | RGBW stripe controller |  | RGBW LD382
LD382A (FW 1.0.6+) in RGB mode | RGB stripe controller |  | RGB LD382
LD382A (FW 1.0.6+) in RGBW mode | RGBW stripe controller |  | RGBW LD382
SENGLED | E27 bulb with build-in WLAN repeater |  | White Sengled
SUNRICHER with RGBW | Controller | *(!!!) | RGBW Sunricher

(1) milght brigbe V2, V3, V4
(2) milight bridge V3, V4
(a) one group per bridge
(b) four independent group per bridge
(nK) no color temp support (Kelvin)
(C) pure color
(W) pure white
(CW) pure Color or pure white
(S20) Saturation <20: switch to pure white channel
(!!!) EXPERIMENTAL

Color

Colors can be specified in RGB or HSV color space.

Color in color space "HSV" are completely and generally more intuitive than RGB.

H (HUE: 0..360) are the basic color in a color wheel.

- Red is at 0 °
- Green at 120 °
- Blue at 240 °

S (Saturation: 0..100) stands for the saturation of the color. A saturation of 100 means the color is "pure" or completely saturated. Blue, for example, with 100% saturation corresponds to RGB # 0000FF.

V (Value: 0..100) indicates the brightness. A value of 50 states that "half brightness".

Color: HSV compared to RGB

Normally, a color may be expressed in the HSV color space as well as in RGB color space.

Colors in the HSV color space usually seem more understandable. To move a Green in the HSV color space a little more toward CYAN, simply increase the HUE value (angle) slightly. In RGB color space, the same task is less intuitive to achieve by increasing blue.

Differences become clear in Transitions however. In order to dim BLUE up the HSV Transitions 240,100,0 -> 240,100,100 would be used. To slowly dim RED (brightness 0) to BLUE the Transition in the HSV color space is 0,100,0 -> 240,100,100. In RGB color space (# 000000 -> # 0000FF) can not distinguish between the two versions. Here (correctly, but probably differently than intended) would appear in both cases, a white (brightness 0) as an initial value.

Define

- `define <name> WifiLight <LED type> <bridgetype>:<IP|FQDN>`

  example

  defines a milight RGBW2 (bulb or LED stripe controller) on a milight bridge version 3 or 4. The LED is allocated to a maximum of 4 groups available per bridge in order of definition:
  `define wz.licht.decke WifiLight RGBW2 bridge-V3:192.168.178.142`

  defines a LD382A Controller with RGBW stripe:
  `define wz.licht.decke WifiLight RGBW LD382A:192.168.178.142`

  defines a LD382A Controller with RGB stripe:
  `define wz.licht.decke WifiLight RGB LD382A:192.168.178.142`

  WifiLight has a "color calibration". Ideally, a calibration should be performed every time after a lamp change or after definition.

Set

- `set <name> on [ramp]`

  Turns on the device. It is either chosen 100% White or the color defined by the attribute "default color".

  Advanced options:

  - ramp

- `set <name> off [ramp]`

  Turns of the device.

  Advanced options:

  - ramp

- `set <name> dimup`

  Increases the brightness by a fixed amount. The attribute "dimStep" or the default "7" is applied.
  This command is useful to increase particularly the brightness by a wall switch or a remote control.

  Advanced options:

  - none

- `set <name> dimdown`

  Decreases the brightness by a fixed amount. The attribute "dimStep" or the default "7" is applied.
  This command is useful to reduce particularly the brightness by a wall switch or a remote control.

  Advanced options:

  - none

- `set <name> dim level [ramp] [q]`

  Sets the brightness to the specified level (0..100). This command also maintains the preset color even with "dim 0" (off) and then "dim xx" (turned on) at. Therefore, it represents an alternative form to "off" / "on". The latter would always choose the "default color".

  Advanced options:

  - ramp

  Flags:

  - q

- `set <name> HSV H,S,V [ramp] [s|l|q] [event]`

  Sets the color in the HSV color space. If the ramp is specified (as a time in seconds), the module calculates a soft color transition from the current color to the newly set.

  For example, sets a saturated blue with half brightness:
  `set wz.licht.decke HSV 240,100,50`

  Advanced options:

  - ramp

  Flags:

  - s l q event

- `set <name> RGB RRGGBB [ramp] [l|s|q] [event]`

  Sets the color in the RGB color space.

  Advanced options:

  - ramp

  Flags:

  - s l q event

Meaning of Flags

Certain commands (set) can be marked with special flags.

- ramp:
  Time in seconds for a soft color or brightness transition. The soft transition starts at the currently visible color and is calculated for the specified.
- s:
  (short, default). A smooth transition to another color is carried out in the "color wheel" on the shortest path. A transition from red to green lead by the shortest route through yellow.
- l:
  (long). A smooth transition to another color is carried out in the "color wheel" on the "long" way. A transition from red to green then leads across magenta, blue, and cyan.
- q:
  (queue). Commands with this flag are cached in an internal queue and will not run before the currently running soft transitions have been processed. Commands without the flag will be processed immediately. In this case all running transitions are stopped immediately and the queue will be cleared.
- event:
  designator ([A-Za-z_0-9])

  WifiLight creates, when using this flag, during transitions to another color messages (events) in the form:

  `WifiLight <NAME> programm: <EVENT> <XX>`.

  <EVENT> is the designator as specified in the flag.
  <XX> is the progress (percentage) of the transition.

  Depending on the total duration of the transition, the values from 0 to 100 will not completely go through but for 0% and 100% is guaranteed always a event. To these events can then be reacted within a notify or DOIF to (for example):

  - increase the volume of a radio when a lamp is turned on in the morning slowly
  - A color transition can be restarted in a notify if it is complete (loop it, even complex transitions)
  - Other light sources can be synchronized by individually created color transitions.

color calibration

WifiLight supports two different types of color calibrations:

Correction of saturated colors

background:

YELLOW, for example, is defined as a mixture of red and green light in equal parts. Depending on the LED and control used the green channel may be much more luminous. If the red and green LEDs are each fully driven, GREEN predominates in this mixture and the desired YELLOW would get a distinct green tint. In this example, no yellow would be generated (corresponding to 60 ° in the "color wheel") for HSV 60,100,100. Instead GREEN would be generated with yellow tinge, perhaps corresponding to an estimated color angle of 80 °. The required correction for yellow would therefore minus 20° (60° target - 80° result = -20° correction). YELLOW may have to be corrected as to -20 °. Possible values per correction point are +/- 29 °.

procedure:

The correction of the full color is controlled by the attribute "color cast". Here 6 (comma separated) values are specified in the range from -29 to 29. These values are in accordance with the angle correction for red (0 °), yellow (60 °), green (120 °), cyan (180 °), blue (240 °) and magenta (300 °). First, the deviation of the mixed colors (60 ° / 180 ° / 300 °) should be determined as in the above example, and stored in the attribute. Following the primary colors (0 ° / 120 ° / 240 °) should be corrected so that the smooth transitions between adjacent pure colors appear as linear as possible. This process may need to be repeated iteratively multiple times until the result is harmonious.

White Balance

background:

Some bulbs produce white light by mixing the RGB channels (for example, LW12). Depending on the light intensity of the RGB channels of the LED strips used, the result is different. One or two colors dominate. In addition, there are various types of white light. Cold light has a higher proportion of blue. In Central Europe mostly warm white light is used for light sources. This has a high red and low blue component.

WifiLight offers the possibility for mixed RGB white to adapt the composition. The adjustment is carried out via the attribute "white point". The attribute expects a value between 0 and 1 (decimal point with) and the three colors are separated by a comma for each of the three RGB channels.

procedure:

A value of "1,1,1" sets all the three channels to 100% each. Assuming that the blue component of the white light should be reduced, a value of "1,1,0.5" sets the third channel (BLUE) in white on 0.5 according to 50%. Before doing a white balance correction the adjusment of the saturated color should be completed.

Attribute

- `attr <name> colorCast <R,Y,G,C,B,M>`

  color calibration of saturated colors. R(ed), Y(ellow), G(reen), C(yan), B(lue), M(agenta) in the range of +/- 29 (degrees)

- `attr <name> defaultColor <H,S,V>`

  Specify the light color in HSV which is selected at "on". Default is white.

- `attr <name> defaultRamp <0 bis X>`

  Time in seconds. If this attribute is set, a smooth transition is always implicitly generated if no ramp in the set is indicated.

- `attr <name> dimStep <0 bis 100>`

  Value by which the brightness at dim up and dim-down is changed. Default is "7"

- `attr <name> gamma <X.X>`

  The human eye perceives brightness changes very differently to (logarithmic). At low output brightness even a small change in brightness is perceived as very strong and on the other side strong changes are needed at high luminance. Therefore, a logarithmic correction of brightness increase of lamps is necessary so that the increase is found to be uniform. Some controllers perform this correction internally. In other cases it is necessary to store this correction in the module. A gamma value of 1.0 (default) results in a linear output values. Values less than 1.0 lead to a logarithmic correction.

- `attr <name> whitePoint <R,G,B>`

  color calibration for mixed RGB white light.

- `attr <name> readingFnAttributes`

Colored device-icon for FhemWeb

To activate a colored icon for FhemWeb the following attribute must be set:

- `attr <name> devStateIcon {Color_devStateIcon(ReadingsVal($name,"RGB","000000"))}`

Colorpicker for FhemWeb

In order for the Color Picker can be used in FhemWeb following attributes need to be set:

- `attr <name> webCmd RGB`
- `attr <name> widgetOverride RGB:colorpicker,RGB`

### Wunderground

This module gets weather data and forecast from Weather Underground weather service.
Define

`define <name> Wunderground <api-key> <query>`
Example:

`define WUweather Wunderground d123ab11bb2c3456 IBAYERNM70
define WUweather Wunderground d123ab11bb2c3456 Germany/Berlin
`

Set

- update - refresh data

Attributes

- pollInterval - Set regular polling interval in seconds (default=300)
- wu_bestfct - Use Weather Undergrond Best Forecast for forecast (default=1)
- wu_features - One or more of the data features to be fetched (default=astronomy,conditions,forecast)
- wu_lang - Returns the API response in the specified language (default=en)
- wu_pws - Use personal weather stations for conditions (default=1)

### X10

Define

`define <name> X10 <model> <housecode> <unitcode>`
Defines an X10 device via its model, housecode and unitcode.
Notes:

- `<model>` is one of
  - `lm12`: lamp module, dimmable
  - `lm15`: lamp module, not dimmable
  - `am12`: appliance module, not dimmable
  - `tm12`: tranceiver module, not dimmable. Its unitcode is 1.
  Model determines whether a dim command is reasonable to be sent or not.
- `<housecode>` ranges from A to P.
- `<unitcode>` ranges from 1 to 16.

Examples:

`define lamp1 X10 lm12 N 10`
`define pump X10 am12 B 7`
`define lamp2 X10 lm15 N 11`

Set

`set <name> <value> [<argument>]`
where `value` is one of:

        dimdown           # requires argument, see the note
        dimup             # requires argument, see the note
        off
        on
        on-till           # Special, see the note
        on-for-timer      # Special, see the note

Examples:

`set lamp1 dimup 10`
`set lamp1,lamp2 off`
`set pump off`
`set lamp2 on-till 19:59`
`set lamp2 on-for-timer 00:02:30`

Notes:

- Only switching and dimming are supported by now.
- Dimming is valid only for a dimmable device as specified by the `model` argument in its `define` statement.
- An X10 device has 210 discrete brightness levels. If you use a X10 sender, e.g. a remote control or a wall switch to dim, a brightness step is 100%/210.
- `dimdown` and `dimup` take a number in the range from 0 to 22 as argument. It is assumed that argument 1 is a 1% brightness change (microdim) and arguments 2 to 22 are 10%..100% brightness changes. The meaning of argument 0 is unclear.
- This currently leads to some confusion in the logs as the `dimdown` and `dimup` codes are logged with different meaning of the arguments depending on whether the commands were sent from the PC or from a remote control or a wall switch.
- `dimdown` and `dimup` from on and off states may have unexpected results. This seems to be a feature of the X10 devices.
- `on-till` requires an absolute time in the "at" format (HH:MM:SS, HH:MM) or { <perl code> }, where the perl code returns a time specification). If the current time is greater than the specified time, then the command is ignored, else an "on" command is generated, and for the given "till-time" an off command is scheduleld via the at command.
- `on-for-timer` requires a relative time in the "at" format (HH:MM:SS, HH:MM) or { <perl code> }, where the perl code returns a time specification).

Get

N/A

Attributes

- do_not_notify
- dummy
- showtime
- model (lm12,lm15,am12,tm13)
- IODev
- eventMap

### XBMC

Define

`define <name> XBMC <ip[:port]> <http|tcp> [<username>] [<password>]`
This module allows you to control XBMC and receive events from XBMC. It can also be used to control Plex (see attribute compatibilityMode).
Prerequisites

- Requires XBMC "Frodo" 12.0.
- To use this module you will have to enable JSON-RPC. See here.
- The Perl module JSON is required.
  On Debian/Raspbian: `apt-get install libjson-perl`
  Via CPAN: `cpan install JSON` To get it working on a Fritzbox the JSON module has to be installed manually.

To receive events it is necessary to use TCP. The default TCP port is 9090. Username and password are optional for TCP. Be sure to enable JSON-RPC for TCP. See here.
Example:

`define htpc XBMC 192.168.0.10 tcp
define htpc XBMC 192.168.0.10:9000 tcp # With custom port
define htpc XBMC 192.168.0.10 http # Use HTTP instead of TCP - Note: to receive events use TCP!
define htpc XBMC 192.168.0.10 http xbmc passwd # Use HTTP with credentials - Note: to receive events use TCP!`

Remote control:
There is an simple remote control layout for XBMC which contains the most basic buttons. To add the remote control to the webinterface execute the following commands:

`define <rc_name> remotecontrol #adds the remote control
set <rc_name> layout XBMC_RClayout #sets the layout for the remote control
set <rc_name> makenotify <XBMC_device> #links the buttons to the actions`

Known issues:
XBMC sometimes creates events twices. For example the Player.OnPlay event is created twice if play a song. Unfortunately this is a issue of XBMC. The fix of this bug is included in future version of XBMC (> 12.2).

Set

`set <name> <command> [<parameter>]`
This module supports the following commands:
Player related commands:

- play [<all|audio|video|picture>] - starts the playback (might only work if previously paused). The second argument defines which player should be started. By default the active players will be started
- pause [<all|audio|video|picture>] - pauses the playback
- playpause [<all|audio|video|picture>] - toggles between play and pause for the given player
- stop [<all|audio|video|picture>] - stop the playback
- next [<all|audio|video|picture>] - jump to the next track
- prev [<all|audio|video|picture>] - jump to the previous track or the beginning of the current track.
- goto <position> [<audio|video|picture>] - Goes to the <position> in the playlist. <position> has to be a number.
- shuffle [<toggle|on|off>] [<audio|video|picture>] - Enables/Disables shuffle mode. Without furhter parameters the shuffle mode is toggled.
- repeat <one|all|off> [<audio|video|picture>] - Sets the repeat mode.
- open <URI> - Plays the resource located at the URI (can be a url or a file)
- opendir <path> - Plays the content of the directory
- openmovieid <path> - Plays a movie by id
- openepisodeid <path> - Plays an episode by id
- openchannelid <path> - Switches to channel by id
- addon <addonid> <parametername> <parametervalue> - Executes addon with one Parameter, for example set xbmc addon script.json-cec command activate
- seek <hh:mm:ss> - seek to the specified time

Input related commands:

- back - Back-button
- down - Down-button
- up - Up-button
- left - Left-button
- right - Right-button
- home - Home-button
- select - Select-button
- info - Info-button
- showosd - Opens the OSD (On Screen Display)
- showcodec - Shows Codec information
- exec <action> - Execute an input action. All available actions are listed here
- send <text> - Sends <text> as input to XBMC
- jsonraw - Sends raw JSON data to XBMC

Libary related commands:

- videolibrary clean - Removes non-existing files from the video libary
- videolibrary scan - Scan for new video files
- audiolibrary clean - Removes non-existing files from the audio libary
- audiolibrary scan - Scan for new audio files

Application related commands:

- mute [<0|1>] - 1 for mute; 0 for unmute; by default the mute status will be toggled
- volume <n> - sets the volume to <n>. <n> must be a number between 0 and 100
- volumeDown <n> - volume down
- volumeUp <n> - volume up
- quit - closes XBMC
- off - depending on the value of the attribute "offMode" XBMC will be closed (see quit) or the system will be shut down, put into hibernation or stand by. Default is quit.

System related commands:

- eject - will eject the optical drive
- shutdown - the XBMC host will be shut down
- suspend - the XBMC host will be put into stand by
- hibernate - the XBMC host will be put into hibernation
- reboot - the XBMC host will be rebooted
- connect - try to connect to the XBMC host immediately

Messaging

To show messages on XBMC (little message PopUp at the bottom right egde of the screen) you can use the following commands:
`set <XBMC_device> msg <title> <msg> [<duration>] [<icon>]`
The default duration of a message is 5000 (5 seconds). The minimum duration is 1500 (1.5 seconds). By default no icon is shown. XBMC provides three different icon: error, info and warning. You can also use an uri to define an icon. Please enclose title and/or message into quotes (" or ') if it consists of multiple words.

Generated Readings/Events:

- audiolibrary - Possible values: cleanfinished, cleanstarted, remove, scanfinished, scanstarted, update
- currentAlbum - album of the current song/musicvideo
- currentArtist - artist of the current song/musicvideo
- currentMedia - file/URL of the media item being played
- currentTitle - title of the current media item
- currentTrack - track of the current song/musicvideo
- episode - episode number
- episodeid - id of the episode in the video library
- fullscreen - indicates if XBMC runs in fullscreen mode (on/off)
- label - label of the current media item
- movieid - id of the movie in the video library
- musicvideoid - id of the musicvideo in the video library
- mute - indicates if XBMC is muted (on/off)
- name - software name (e.g. XBMC)
- originaltitle - original title of the movie being played
- partymode - indicates if XBMC runs in party mode (on/off) (not available for Plex)
- playlist - Possible values: add, clear, remove
- playStatus - Indicates the player status: playing, paused, stopped
- repeat - current repeat mode (one/all/off)
- season - season of the current episode
- showtitle - title of the show being played
- shuffle - indicates if the playback is shuffled (on/off)
- skin - current skin of XBMC
- songid - id of the song in the music library
- system - Possible values: lowbattery, quit, restart, sleep, wake
- time - current position in the playing media item (only updated on play/pause)
- totaltime - total run time of the current media item
- type - type of the media item. Possible values: episode, movie, song, musicvideo, picture, unknown
- version - version of XBMC
- videolibrary - Possible values: cleanfinished, cleanstarted, remove, scanfinished, scanstarted, update
- volume - value between 0 and 100 stating the current volume setting
- year - year of the movie being played
- 3dfile - is a 3D movie according to filename
- sd_<type><n>_<reading> - stream details of the current medium. type can be video, audio or subtitle, n is the stream index (a stream can have multiple audio/video streams)

Remarks on the events

The event playStatus = playing indicates a playback of a media item. Depending on the event type different events are generated:

- type = song generated events are: album, artist, file, title and track
- type = musicvideo generated events are: album, artist, file and title
- type = episode generated events are: episode, file, season, showtitle, and title
- type = movie generated events are: originaltitle, file, title, and year
- type = picture generated events are: file
- type = unknown generated events are: file

Attributes

- compatibilityMode
  This module can also be used to control Plex, since the JSON Api is mostly the same, but there are some differences. If you want to control Plex set the attribute compatibilityMode to plex.
- offMode
  Declares what should be down if the off command is executed. Possible values are quit (closes XBMC), hibernate (puts system into hibernation), suspend (puts system into stand by), and shutdown (shuts down the system). Default value is quit
- fork
  If XBMC does not run all the time it used to be the case that FHEM blocks because it cannot reach XBMC (only happened if TCP was used). If you encounter problems like FHEM not responding for a few seconds then you should set `attr <XBMC_device> fork enable` which will move the search for XBMC into a separate process.
- updateInterval
  The interval which is used to check if Kodi is still alive (by sending a JSON ping) and also it is used to update current player item.
- disable
  Disables the device. All connections will be closed immediately.

### Xiaomi Flower Monitor

XiaomiFlowerSens - Retrieves data from a Xiaomi Flower Monitor
With this module it is possible to read the data from a sensor and to set it as reading. Gatttool and hcitool is required to use this modul. (apt-get install bluez)
Define

`define <name> XiaomiFlowerSens <BT-MAC>`
Example:

`define Weihnachtskaktus XiaomiFlowerSens C4:7C:8D:62:42:6F`

This statement creates a XiaomiFlowerSens with the name Weihnachtskaktus and the Bluetooth Mac C4:7C:8D:62:42:6F.
After the device has been created, the current data of the Xiaomi Flower Monitor is automatically read from the device.

Readings

- state - Status of the flower sensor or error message if any errors.
- battery - current battery state dependent on batteryLevel.
- batteryLevel - current battery level in percent.
- fertility - Values for the fertilizer content
- firmware - current device firmware
- lux - current light intensity
- moisture - current moisture content
- temperature - current temperature

Set

- statusRequest - retrieves the current state of the Xiaomi Flower Monitor.
- clearFirmwareReading - clear firmware reading for new begin.

Attributes

- disable - disables the Nuki device
- interval - interval in seconds for statusRequest

### xmllist

`xmllist [devspec]`
Returns an XML tree of device definitions. devspec is optional, and restricts the list of devices if specified.
Example: `

fhem> xmllist
<FHZINFO>

<internal_LIST>

<internal name="global" state="internal" sets="" attrs="room configfile logfile ...">

<INT key="DEF" value="<no definition>"/>
<INT key="NR" value="0"/>
<INT key="STATE" value="internal"/>

[...]

`

### YAMAHA_AVR

Define

`define <name> YAMAHA_AVR <ip-address> [<zone>] [<status_interval>]
define <name> YAMAHA_AVR <ip-address> [<zone>] [<off_status_interval>] [<on_status_interval>]`
This module controls AV receiver from Yamaha via network connection. You are able to power your AV reveiver on and off, query it's power state, select the input (HDMI, AV, AirPlay, internet radio, Tuner, ...), select the volume or mute/unmute the volume.
Defining a YAMAHA_AVR device will schedule an internal task (interval can be set with optional parameter <status_interval> in seconds, if not set, the value is 30 seconds), which periodically reads the status of the AV receiver (power state, selected input, volume and mute status) and triggers notify/filelog commands.
Different status update intervals depending on the power state can be given also. If two intervals are given in the define statement, the first interval statement stands for the status update interval in seconds in case the device is off, absent or any other non-normal state. The second interval statement is used when the device is on. Example:

`define AV_Receiver YAMAHA_AVR 192.168.0.10
# With custom status interval of 60 seconds
define AV_Receiver YAMAHA_AVR 192.168.0.10 mainzone 60
# With custom "off"-interval of 60 seconds and "on"-interval of 10 seconds
define AV_Receiver YAMAHA_AVR 192.168.0.10 mainzone 60 10`

Zone Selection

If your receiver supports zone selection (e.g. RX-V671, RX-V673,... and the AVANTAGE series) you can select the zone which should be controlled. The RX-V3xx and RX-V4xx series for example just have a "Main Zone" (which is the whole receiver itself). In general you have the following possibilities for the parameter <zone> (depending on your receiver model).

- mainzone - this is the main zone (standard)
- zone2 - The second zone (Zone 2)
- zone3 - The third zone (Zone 3)
- zone4 - The fourth zone (Zone 4)

Depending on your receiver model you have not all inputs available on these different zones. The module just offers the real available inputs.
Example:

`define AV_Receiver YAMAHA_AVR 192.168.0.10 # If no zone is specified, the "Main Zone" will be used.
attr AV_Receiver YAMAHA_AVR room Livingroom
# Define the second zone
define AV_Receiver_Zone2 YAMAHA_AVR 192.168.0.10 zone2
attr AV_Receiver_Zone2 room Bedroom`

For each Zone you will need an own YAMAHA_AVR device, which can be assigned to a different room. Each zone can be controlled separatly from all other available zones.

Set

`set <name> <command> [<parameter>]`
Currently, the following commands are defined; the available inputs are depending on the used receiver. The module only offers the real available inputs and scenes. The following input commands are just an example and can differ.

- on - powers on the device
- off - shuts down the device
- input hdm1,hdmX,... - selects the input channel (only the real available inputs were given)
- scene scene1,sceneX - select the scene
- volume 0...100 [direct] - set the volume level in percentage. If you use "direct" as second argument, no volume smoothing is used (if activated) for this volume change. In this case, the volume will be set immediatly.
- volumeStraight -80...15 [direct] - set the volume level in decibel. If you use "direct" as second argument, no volume smoothing is used (if activated) for this volume change. In this case, the volume will be set immediatly.
- volumeUp [0-100] [direct] - increases the volume level by 5% or the value of attribute volumeSteps (optional the increasing level can be given as argument, which will be used instead). If you use "direct" as second argument, no volume smoothing is used (if activated) for this volume change. In this case, the volume will be set immediatly.
- volumeDown [0-100] [direct] - decreases the volume level by 5% or the value of attribute volumeSteps (optional the decreasing level can be given as argument, which will be used instead). If you use "direct" as second argument, no volume smoothing is used (if activated) for this volume change. In this case, the volume will be set immediatly.
- mute on|off|toggle - activates volume mute
- bass [-6...6] step 0.5 (main zone), [-10...10] step 2 (other zones), [-10...10] step 1 (other zones, DSP models) - set bass tone level in decibel
- treble [-6...6] step 0.5 (main zone), [-10...10] step 2 (other zones), [-10...10] step 1 (other zones, DSP models) - set treble tone level in decibel
- dsp hallinmunich,hallinvienna,... - sets the DSP mode to the given preset
- enhancer on|off - controls the internal sound enhancer
- 3dCinemaDsp auto|off - controls the CINEMA DSP 3D mode
- adaptiveDrc auto|off - controls the Adaptive DRC
- partyMode on|off - controls the party mode. In Main Zone the whole party mode is enabled/disabled system wide. In each zone executed, it enables/disables the current zone from party mode.
- navigateListMenu [item1]/[item2]/.../[itemN] - select a specific item within a menu structure. for menu-based inputs (e.g. Net Radio, USB, Server, ...) only. See chapter Automatic Menu Navigation for further details and examples.
- tunerFrequency [frequency] [AM|FM] - sets the tuner frequency. The first argument is the frequency, second parameter is optional to set the tuner band (AM or FM, default: FM). Depending which tuner band you select, the frequency is given in kHz (AM band) or MHz (FM band). If the second parameter is not set, the FM band will be used. This command can be used even the current input is not "tuner", the new frequency is set and will be played, when the tuner gets active.
- preset 1...40 - selects a saved preset of the currently selected input.
- presetUp - selects the next preset of the currently selected input.
- presetDown - selects the previous preset of the currently selected input.
- straight on|off - bypasses the internal codec converter and plays the original sound codec
- direct on|off - bypasses all internal sound enhancement features and plays the sound straight directly
- sleep off,30min,60min,...,last - activates the internal sleep timer
- shuffle on,off - activates the shuffle mode on the current input
- repeat one,all,off - activates the repeat mode on the current input for one or all titles
- pause - pause playback on current input
- play - start playback on current input
- stop - stop playback on current input
- skip reverse,forward - skip track on current input
- statusRequest - requests the current status of the device
- remoteControl up,down,... - sends remote control commands as listed below

Remote control (not in all zones available, depending on your model)

Cursor Selection:

`remoteControl up
remoteControl down
remoteControl left
remoteControl right
remoteControl enter
remoteControl return
`

Menu Selection:

`remoteControl setup
remoteControl option
remoteControl display
`

Tuner Control:

`remoteControl tunerPresetUp
remoteControl tunerPresetDown
`

The button names are the same as on your remote control.

Automatic Menu Navigation (only for menu based inputs like Net Radio, Server, USB, ...)

For menu based inputs you have to select a specific item out of a complex menu structure to start playing music. Mostly you want to start automatic playback for a specific internet radio (input: Net Radio) or similar, where you have to navigate through several menu and submenu items.
To automate such a complex menu navigation, you can use the set command "navigateListMenu". As Parameter you give a menu path of the desired item you want to select. YAMAHA_AVR will go through the menu and selects all menu items given as parameter from left to right. All menu items are separated by a forward slash (/).
So here are some examples: Receiver's current input is "netradio":

`set <name> navigateListMenu Countries/Australia/All Stations/1Radio.FM
set <name> navigateListMenu Bookmarks/Favorites/1LIVE`

If you want to turn on your receiver and immediatly select a specific internet radio you may use:

`set <name> on ; set <name> volume 20 direct ; set <name> input netradio ; set <name> navigateListMenu Bookmarks/Favorites/1LIVE
# for regular execution to a specific time using the at module
define turn_on_Radio_morning at *08:00 set <name> on ; set <name> volume 20 direct ; set <name> input netradio ; set <name> navigateListMenu Countries/Australia/All Stations/1Radio.FM
define turn_on_Radio_evening at *17:00 set <name> on ; set <name> volume 20 direct ; set <name> input netradio ; set <name> navigateListMenu Bookmarks/Favorites/1LIVE`

Receiver's current input is "server" (network DLNA shares):

`set <name> navigateListMenu NAS/Music/Sort By Artist/Alicia Keys/Songs in A Minor/Fallin`

The exact menu structure depends on your own configuration and network devices who provide content. Each menu item name has not to be provided fully. Each item name will be treated as keyword search. That means, if any menu item contains the given item name, it will be selected, for example:

Your real menu path you want to select looks like this: `Bookmarks => Favorites => foo:BAR 70's-90's [[HITS]]`
The last item has many non-word characters, that can cause you trouble in some situations. But you don't have to use the full name to select this entry. It's enough to use a specific part of the item name, that only exists in this one particular item. So to select this item you can use for instance the following set command:
`set <name> navigateListMenu Bookmarks/Favorites/foo:BAR`
This works, even without giving the full item name (`foo:BAR 70's-90's [[HITS]]`).

This also allows you to pare down long item names to shorter versions. The shorter version must be still unique enough to identify the right item. The first item in the list (from top to bottom), that contains the given keyword, will be selected.

Get

`get <name> <reading>`
Currently, the get command only returns the reading values. For a specific list of possible values, see section "Generated Readings/Events".

Attributes

- do_not_notify
- disabledForIntervals
- readingFnAttributes
- request-timeout
Optional attribute change the response timeout in seconds for all queries to the receiver.
Possible values: 1-5 seconds. Default value is 4 seconds.
- disable
Optional attribute to disable the internal cyclic status update of the receiver. Manual status updates via statusRequest command is still possible.
Possible values: 0 => perform cyclic status update, 1 => don't perform cyclic status updates.
- volume-smooth-change
Optional attribute to activate a smooth volume change.
Possible values: 0 => off , 1 => on
- volume-smooth-steps
Optional attribute to define the number of volume changes between the current and the desired volume. Default value is 5 steps
- volumeSteps
Optional attribute to define the default increasing and decreasing level for the volumeUp and volumeDown set command. Default value is 5%

Generated Readings/Events:

- 3dCinemaDsp - The status of the CINEMA DSP 3D mode (can be "auto" or "off")
- adaptiveDrc - The status of the Adaptive DRC (can be "auto" or "off")
- bass Reports the current bass tone level of the receiver or zone in decibel values (between -6 and 6 dB (mainzone) and -10 and 10 dB (other zones)
- dsp - The current selected DSP mode for sound output
- direct - indicates if all sound enhancement features are bypassed or not ("on" => all features are bypassed, "off" => sound enhancement features are used).
- enhancer - The status of the internal sound enhancer (can be "on" or "off")
- input - The selected input source according to the FHEM input commands
- inputName - The input description as seen on the receiver display
- mute - Reports the mute status of the receiver or zone (can be "on" or "off")
- newFirmware - indicates if a firmware update is available (can be "available" or "unavailable"; only available for RX-Vx71, RX-Vx73, RX-Ax10 or RX-Ax20)
- power - Reports the power status of the receiver or zone (can be "on" or "off")
- presence - Reports the presence status of the receiver or zone (can be "absent" or "present"). In case of an absent device, it cannot be controlled via FHEM anymore.
- partyMode - indicates if the party mode is enabled/disabled for the whole device (in main zone) or if the current zone is enabled for party mode (other zones than main zone)
- tunerFrequency - the current tuner frequency in kHz (AM band) or MHz (FM band)
- tunerFrequencyBand - the current tuner band (AM or FM)
- volume - Reports the current volume level of the receiver or zone in percentage values (between 0 and 100 %)
- volumeStraight - Reports the current volume level of the receiver or zone in decibel values (between -80.5 and +15.5 dB)
- sleep - indicates if the internal sleep timer is activated or not.
- straight - indicates if the internal sound codec converter is bypassed or not (can be "on" or "off")
- state - Reports the current power state and an absence of the device (can be "on", "off" or "absent")
- treble Reports the current treble tone level of the receiver or zone in decibel values (between -6 and 6 dB (mainzone) and -10 and 10 dB (other zones)
Input dependent Readings/Events:
- currentChannel - Number of the input channel (SIRIUS only)
- currentStation - Station name of the current radio station (available only on TUNER, HD RADIO, NET RADIO or PANDORA)
- currentStationFrequency - The tuner frequency of the current station (only available on Tuner or HD Radio)
- currentAlbum - Album name of the current song
- currentArtist - Artist name of the current song
- currentTitle - Title of the current song
- playStatus - indicates if the input plays music or not
- shuffle - indicates the shuffle status for the current input
- repeat - indicates the repeat status for the current input

Implementator's note

The module is only usable if you activate "Network Standby" on your receiver. Otherwise it is not possible to communicate with the receiver when it is turned off.

### YAMAHA_BD

Define

`define <name> YAMAHA_BD <ip-address> [<status_interval>]
define <name> YAMAHA_BD <ip-address> [<off_status_interval>] [<on_status_interval>]`
This module controls Blu-Ray players from Yamaha via network connection. You are able to switch your player on and off, query it's power state, control the playback, open and close the tray and send all remote control commands.
Defining a YAMAHA_BD device will schedule an internal task (interval can be set with optional parameter <status_interval> in seconds, if not set, the value is 30 seconds), which periodically reads the status of the player (power state, current disc, tray status,...) and triggers notify/filelog commands.
Different status update intervals depending on the power state can be given also. If two intervals are given to the define statement, the first interval statement represents the status update interval in seconds in case the device is off, absent or any other non-normal state. The second interval statement is used when the device is on. Example:

`define BD_Player YAMAHA_BD 192.168.0.10
# With custom status interval of 60 seconds
define BD_Player YAMAHA_BD 192.168.0.10 60
# With custom "off"-interval of 60 seconds and "on"-interval of 10 seconds
define BD_Player YAMAHA_BD 192.168.0.10 60 10`

Set

`set <name> <command> [<parameter>]`
Currently, the following commands are defined.

- on - powers on the device
- off - shuts down the device
- tray open,close - open or close the disc tray
- statusRequest - requests the current status of the device
- remoteControl up,down,... - sends remote control commands as listed in the following chapter

Playback control commands

- play - start playing the current media
- pause - pause the current media playback
- stop - stop the current media playback
- skip forward,reverse - skip the current track or chapter
- fast forward,reverse - fast forward or reverse playback
- slow forward,reverse - slow forward or reverse playback
- trickPlay normal,repeatChapter,repeatTitle,... - controls the Trick-Play features

Remote control

The following commands are available:
Number Buttons (0-9):

`remoteControl 0
remoteControl 1
remoteControl 2
...
remoteControl 9
`

Cursor Selection:

`remoteControl up
remoteControl down
remoteControl left
remoteControl right
remoteControl enter
remoteControl return
`

Menu Selection:

`remoteControl OSDonScreen
remoteControl OSDstatus
remoteControl popupMenu
remoteControl topMenu
remoteControl setup
remoteControl home
remoteControl clear
`

Color Buttons:

`remoteControl red
remoteControl green
remoteControl yellow
remoteControl blue
`

Play Control Buttons:

`remoteControl program
remoteControl search
remoteControl repeat
remoteControl repeat-AB
remoteControl subtitle
remoteControl audio
remoteControl angle
remoteControl pictureInPicture
remoteControl secondAudio
remoteControl secondVideo
`

The button names are the same as on your remote control.

Get

`get <name> <reading>`
Currently, the get command only returns the reading values. For a specific list of possible values, see section "Generated Readings/Events".

Attributes

- do_not_notify
- readingFnAttributes
- disable
Optional attribute to disable the internal cyclic status update of the player. Manual status updates via statusRequest command is still possible.
Possible values: 0 => perform cyclic status update, 1 => don't perform cyclic status updates.
- request-timeout
Optional attribute change the response timeout in seconds for all queries to the player.
Possible values: 1-5 seconds. Default value is 4 seconds.

Generated Readings/Events:

- input - The current playback source (e.g. "DISC", "USB", "Network", "YouTube", ...)
- discType - The current type of disc, which is inserted (e.g. "No Disc", "CD", "DVD", "BD", ...)
- contentType - The current type of content, which is played (e.g. "audio", "video", "photo" or "no contents")
- error - indicates an hardware error of the player (can be "none", "fan error" or "usb overcurrent")
- power - Reports the power status of the player or zone (can be "on" or "off")
- presence - Reports the presence status of the player or zone (can be "absent" or "present"). In case of an absent device, it cannot be controlled via FHEM anymore.
- trayStatus - The disc tray status (can be "open" or "close")
- trickPlay - The current trickPlay mode
- state - Reports the current power state and an absence of the device (can be "on", "off" or "absent")
Input dependent Readings/Events:
- currentChapter - Number of the current DVD/BD Chapter (only at DVD/BD's)
- currentMedia - Name of the current file (only at USB)
- currentTrack - Number of the current CD-Audio title (only at CD-Audio)
- currentTitle - Number of the current title (only at DVD/BD's)
- playTimeCurrent - current timecode of played media
- playTimeTotal - the total time of the current movie (only at DVD/BD's)
- playStatus - indicates if the player plays media or not (can be "play", "pause", "stop", "fast fwd", "fast rev", "slow fwd", "slow rev")
- totalTracks - The number of total tracks on inserted CD-Audio

Implementator's note

- Some older models (e.g. BD-S671) cannot be controlled over networked by delivery. A firmware update is neccessary to control these models via FHEM. In general it is always recommended to use the latest firmware.
- The module is only usable if you activate "Network Control" on your player. Otherwise it is not possible to communicate with the player.

### YAMAHA_NP

Define

`define <name> YAMAHA_NP <ip-address> [<status_interval>]
define <name> YAMAHA_NP <ip-address> [<off_status_interval>] [<on_status_interval>]`
This module controls a Yamaha Network Player (such as MCR-N560, MCR-N560D, CRX-N560, CRX-N560D, CD-N500 or NP-S2000) via Ethernet. Theoretically, any device understanding the communication protocol of the Yamaha Network Player App should work.
Currently implemented features:

- Power on/off
- Timer on/off
- Input selection
- Timer on/off
- Volume +/-
- Mute on/off
- System Clock Update
- Tuner: tune +/-, preset +/-, Station information (FM/DAB)
- Stand-by mode: eco/normal
- Player (play, stop, next, prev, shuffle, repeat)
- Menu navigation
- ...

Defining a YAMAHA_NP device will schedule an internal task (interval can be set with optional parameters <off_status_interval> and <on_status_interval> in seconds.
<off_status_interval> is a parameter used in case the device is powered off or not available.
<on_status_interval> is a parameter used in case the device is powered on.
If both parameters are unset, a default value 30 (seconds) for both is used.
If <off_status_interval> is set only the same value is used for both parameters.
The internal task periodically reads the status of the Network Player (power state, selected input, volume and mute status etc.) and triggers notify/filelog commands.
Example:

Add the following code into the fhem.cfg configuration file and restart fhem:
`define NP_Player YAMAHA_NP 192.168.0.15
attr NP_player webCmd input:volume:mute:volumeDown:volumeUp
# With custom status interval of 60 seconds
define NP_Player YAMAHA_NP 192.168.0.15 60
attr NP_player webCmd input:volume:mute:volumeDown:volumeUp
# With custom "off"-interval of 60 seconds and "on"-interval of 10 seconds
define NP_Player YAMAHA_NP 192.168.0.15 60 10
attr NP_player webCmd input:volume:mute:volumeDown:volumeUp`

Set

`set <name> <command> [<parameter>]`
Currently, the following commands are defined.
The available inputs are depending on the used network player. The module offers only available inputs.
Note: Commands and parameters are case sensitive.

Available commands:
- cdTray - open/close the CD tray.
- clockUpdate - updates the system clock with current time. The time information is taken from the FHEM server.
- dimmer [1..3] - Sets the display brightnes.
- input [<parameter>] - selects the input channel. The inputs are read dynamically from the device. Available inputs can be set (e.g. cd, tuner, aux1, aux2, ...).
- mute [on|off] - activates/deactivates muting
- off - shuts down the device
- on - powers on the device
- player [<parameter>] - sets player related commands.

- play - play.
- stop - stop.
- pause - pause.
- next - next item.
- prev - previous item.
- shuffleToggle - Toggles the shuffle mode.
- repeatToggle - Toggles the repeat modes.

- playerListCursorDown - Command for list navigation in inputs such as Net Radio or Server. Command moves the cursor down. Next line displayed.
- playerListCursorReturn - Command for list navigation in inputs such as Net Radio or Server. Command returns from a hierarchical sub-menu. Higher level menu displayed.
- playerListCursorUp - Command for list navigation in inputs such as Net Radio or Server. Command moves the cursor up. Previous line displayed.
- playerListGetList - Command for list navigation in inputs such as Net Radio or Server. Command returns readings relevant for list/menu navigation.
- playerListJumpLine [value] - Command for list navigation in inputs such as Net Radio or Server. Command jumps to a given line.
- playerListSelectLine [value] - Command for list navigation in inputs such as Net Radio or Server. Command selects the given line. In case the line is a 'Container' (folder) it's entered. In case of 'Item' the playback starts.
- sleep [off|30min|60min|90min|120min] - activates the internal sleep timer
- standbyMode [eco|normal] - set the standby mode.
- statusRequest [<parameter>] - requests the current status of the device

- basicStatus - requests the basic status such as volume input etc.
- playerStatus - requests the player status such as play status, song info, artist info etc.
- standbyMode - requests the standby mode information
- systemConfig - requests the system configuration
- tunerStatus - requests the tuner status such as FM frequency, preset number, DAB information etc.
- timerStatus - requests device's internal wake-up timer status
- networkInfo - requests device's network related information such as IP, Gateway, MAC address etc.

- timerHour [0...23] - sets hour of device's internal wake-up timer
- timerMinute [0...59] - sets minutes of device's internal wake-up timer
- timerRepeat [once|every] - sets repetition mode of device's internal wake-up timer
- timerSet - configures the timer according to timerHour, timerMinute, timerRepeat, timerVolume. (ALL parameters must be set before. This command does not switch on the timer. → 'timer on'.)
- timerVolume [<VOL_MIN>...<VOL_MAX>] - sets volume of device's internal wake-up timer
- timer [on|off] - sets device's internal wake-up timer. (Note: The timer will be activated according to the last stored timer parameters in the device. In order to modify please use the 'timerSet' command.)
- tuner [<parameter>] - sets tuner related commands.

- bandDAB - sets the tuner band to DAB (if available).
- bandFM - sets the tuner band to FM.
- tuneUp - tuner tune up.
- tuneDown - tuner tune down.
- presetUp - tuner preset up.
- presetDown - tuner preset down.

- tunerFMFrequency [87.50 ... 108.00] - Sets the FM frequency. The value must be 87.50 ... 108.00 including the decimal point ('.') with two digits after. Otherwise the value will be ignored.
- tunerPresetDAB [1...30] - Sets the DAB preset.
- tunerPresetFM [1...30] - Sets the FM preset.
- volume [0...100] - set the volume level in %
- volumeStraight [<VOL_MIN>...<VOL_MAX>] - set the volume as used and displayed in the device. <VOL_MIN> and <VOL_MAX> are read and set from the device automatically.
- volumeUp [<VOL_MIN>...<VOL_MAX>] - increases the volume by one device's absolute step. <VOL_MIN> and <VOL_MAX> are read and set from the device automatically.
- volumeDown [<VOL_MIN>...<VOL_MAX>] - increases the volume by one device's absolute step. <VOL_MIN> and <VOL_MAX> are read and set from the device automatically.

A typical example is powering the device remotely and tuning the favourite radio station:
Add the following code into the fhem.cfg configuration file:

`define NP_player YAMAHA_NP 192.168.0.15 30 5
attr NP_player webCmd input:volume:mute:volumeDown:volumeUp`

Add the following code into the 99_MyUtils.pm file:

`sub startMyFavouriteRadioStation()
{
fhem "set NP_player on";
sleep 1;
fhem "set NP_player input tuner";
sleep 1;
fhem "set NP_player tunerPresetDAB 1";
sleep 1;
fhem "set NP_player volume 30";
}`

It's a good idea to insert a 'sleep' instruction between each fhem commands due to internal processing time of the network player. During that time the following commands might be ignored...
Now the function can be called by typing the following line in the FHEM command line or by the notify-definitions:

`{startMyFavouriteRadioStation()}
`

Get

`get <name> <reading>`
Currently, the 'get' command returns reading values only. For a specific list of possible values, see section "Generated Readings".

Attributes

- do_not_notify
- readingFnAttributes
- request-timeout
Optional attribute change the response timeout in seconds for all queries to the receiver.
Possible values: 1...5 seconds. Default value is 4 seconds.
- disable
Optional attribute to disable the internal cyclic status update of the receiver. Manual status updates via statusRequest command is still possible.
Possible values: 0 → perform cyclic status update, 1 → don't perform cyclic status updates.
- auto-update-player-readings
Optional attribute for auto refresh of player related readings. Default is 1.
- auto-update-tuner-readings
Optional attribute for auto refresh of tuner related readings. Default is 1.
- smooth-volume-change
Optional attribute for smooth volume change (more Ethernet traffic is generated during volume change). Default is 1.

Readings

Basic readings:
- input - The selected input source according to the FHEM input commands
- mute - Reports the mute status of the receiver (on|off)
- power - Reports the power status of the receiver (on|off)
- presence - Reports the presence status of the receiver or zone (absent|present). Note: In case of "absent", the device cannot be controlled by FHEM. Check standbyMode.
- volume - Reports the current volume level of the receiver in % (0...100%)
- volumeStraight - Reports the current volume level of the receiver as used and displayed in the device (values device specific)
- sleep - Reports the current sleep timer status (30min|60min|90min|120min|off).
- standbyMode - Reports the standby mode (eco|normal).
- state - Reports the current power state and an absence of the device (on|off|absent)
Player related readings:
Note: In order to update the following readings use "statusRequest playerStatus" first.
- playerPlaybackInfo - Reports current player state (play|stop|pause).
- playerDeviceType - Reports the device type (ipod|msc).
- playerIpodMode - Reports the Ipod Mode (normal|off)
- playerRepeat - Reports the Repeat Mode (one|off)
- playerShuffle - Reports the Shuffle Mode (on|off)
- playerPlayTime - Reports the play time of the currently played audio (HH:MM:SS).
- playerTrackNumber - Reports the track number of the currently played audio.
- playerTotalTracks - Reports the total number of tracks for playing.
- playerArtist - Reports the artist (if available) of the currently played audio.
- playerAlbum - Reports the album (if available) of the currently played audio.
- playerSong - Reports the song name (if available) of the currently played audio.
- playerAlbumArtURL - Reports the album art url (if available) of the currently played audio. The URL points to the network player.
- playerAlbumArtID - Reports the album art ID (if available) of the currently played audio.
- playerAlbumArtFormat - Reports the album art format (if available) of the currently played audio.
Player List (Menu) related readings:
Note: In order to update the following readings use "statusRequest playerStatus" first.
- playerListCurrentLine - Reports the current active list line as displayd.
- playerListLine_1..._8 - Reports the content of the Line 1...8 as provided by the device.
- playerListLine_Attribute_1..._8 - Reports the attribute of the Line 1...8 (Container|Item|Unselectable).
- playerListMaxLine - Reports the number of lines in current list/menu.
- playerListMenuName - Reports the name of the current list/menu.
- playerListStatus - Reports the status of the current list/menu (Busy|Ready).
Tuner related readings:
Note: In order to update the following readings use "statusRequest tunerStatus" first.
- tunerAudioModeDAB - Reports current audio mode (Mono|Stereo).
- tunerBand - Reports the currently selected tuner band (FM|DAB). DAB if available.
- tunerBitRateDAB - Reports current DAB stream bit rate (kbit/s).
- tunerPresetFM - Reports the currently selected FM preset. If stored as such (1...30).
- tunerFrequencyDAB - Reports the currently tuned DAB frequency. (xxx.xxx MHz)
- tunerFrequencyFM - Reports the currently tuned FM frequency. (xxx.xx MHz)
- tunerModeDAB - Reports current DAB audio mode (DAB|DAB+).
- tunerProgramServiceFM - Reports the FM service name.
- tunerRadioTextAFM - Reports the Radio Text A of the selected FM service.
- tunerRadioTextBFM - Reports the Radio Text B of the selected FM service.
- tunerPresetDAB - Reports the currently selected DAB preset. If stored as such (1...30).
- tunerServiceLabelDAB - Reports the service label of the selected DAB service.
- tunerChannelLabelDAB - Reports the channel label of the selected DAB service.
- tunerDLSDAB - Reports the dynamic label segment of the selected DAB service.
- tunerEnsembleLabelDAB - Reports the ensemble label of the selected DAB service.
Timer related readings:
Note: In order to update the following readings use "statusRequest timerStatus" first.
- timer - Reports the time mode (on|off).
- timerRepeat - Reports the timer repeat mode (once|every).
- timerStartTime - Reports the timer start time (HH:MM).
- timerVolumeLevel - Reports the timer volume level.

Implementer's note

Trivial: In order to use that module the network player must be connected to the Ethernet.
The device must be in standbyMode "Normal" in order to power on.
However, even if the standbyMode is set to "Eco" the device can be powered off. In that case it has to be switched on manually.

### ZWCUL

This module serves a CUL in ZWave mode (starting from culfw version 1.66), which is attached via USB or TCP/IP, and enables the use of ZWave devices (see also the ZWave module).
Define

`define <name> ZWCUL <device> <homeId> <ctrlId>`
Since the DevIo module is used to open the device, you can also use devices connected via TCP/IP. See this paragraph on device naming details.
Example:

`define ZWCUL_1 ZWCUL /dev/cu.usbmodemfa141@9600 12345678 01`

If the homeId is set to 00000000, then culfw will enter monitor mode, i.e. no acks for received messages will be sent, and no homeId filtering will be done.

Set

- reopen
  First close and then open the device. Used for debugging purposes.
- led [on|off|blink]
  Set the LED on the CUL.
- raw
  send a raw string to culfw
- addNode [on|onSec|off]
  Activate (or deactivate) inclusion mode. The CUL will switch to dataRate 9600 until terminating this mode with off, or a node is included. If onSec is specified, the ZWCUL networkKey ist set, and the device supports the SECURITY class, then a secure inclusion is attempted.
- addNodeId <decimalNodeId>
  Activate inclusion mode, and assign decimalNodeId to the next node. To deactivate this mode, use addNode off. Note: addNode won't work for a FHEM2FHEM:RAW attached ZWCUL, use addNodeId instead
- removeNode [onNw|on|off]
  Activate (or deactivate) exclusion mode. Like with addNode, the CUL will switch temporarily to dataRate 9600, potentially missing some packets sent on higher dataRates. Note: the corresponding fhem device have to be deleted manually.

Get

- homeId
  return the homeId and the ctrlId of the controller.
- nodeInfo
  return node specific information. Needed by developers only.
- raw
  Send raw data to the controller.

Attributes

- dataRate [40k|100k|9600]
  specify the data rate.
- dummy
- do_not_notify
- model
- disable
- networkKey
- intruderMode
  In monitor mode (see above) events are not dispatched to the ZWave module per default. Setting this attribute will allow to get decoded messages, and to send commands to devices not included by this controller.
- verbose
  If the verbose attribute of this device (not global!) is set to 5 or higher, then detailed logging of the RF message will be done.

Generated events: TODO

### ZWDongle

This module serves a ZWave dongle, which is attached via USB or TCP/IP, and enables the use of ZWave devices (see also the ZWave module). It was tested wit a Goodway WD6001, but since the protocol is standardized, it should work with other devices too. A notable exception is the USB device from Merten.
Define

`define <name> ZWDongle <device>`
Upon initial connection the module will get the homeId of the attached device. Since the DevIo module is used to open the device, you can also use devices connected via TCP/IP. See this paragraph on device naming details.
Example:

`define zwdongle_1 ZWDongle /dev/cu.PL2303-000014FA@115200`

Set

- addNode on|onNw|onSec|onNwSec|off
  Activate (or deactivate) inclusion mode. The controller (i.e. the dongle) will accept inclusion (i.e. pairing/learning) requests only while in this mode. After activating inclusion mode usually you have to press a switch three times within 1.5 seconds on the node to be included into the network of the controller. If autocreate is active, a fhem device will be created after inclusion. "on" activates standard inclusion. "onNw" activates network wide inclusion (only SDK 4.5-4.9, SDK 6.x and above).
  If onSec/onNwSec is specified, the ZWDongle networkKey ist set, and the device supports the SECURITY class, then a secure inclusion is attempted.
- backupCreate 16k|32k|64k|128k|256k
  read out the NVRAM of the ZWDongle, and store it in a file called <ZWDongle_Name>.bin in the modpath folder. Since the size of the NVRAM is currently unknown to FHEM, you have to specify the size. The ZWave.me ZME_UZB1 Stick seems to have 256k of NVRAM. Note: writing the file takes some time, usually about 10s for each 64k (and significantly longer on Windows), and FHEM is blocked during this time.
- backupRestore
  Restore the file created by backupCreate. Restoring the file takes about the same time as saving it, and FHEM is blocked during this time. Note / Important: this function is not yet tested for older devices using the MEMORY functions.
- controllerChange on|stop|stopFailed
  Add a controller to the current network and transfer role as primary to it. Invoking controller is converted to secondary.
  stop: stop controllerChange
  stopFailed: stop controllerChange and report an error
- createNewPrimary on|stop|stopFailed
  Add a controller to the current network as a replacement for an old primary. Command can be invoked only by a secondary configured as basic SUC
  stop: stop createNewPrimary
  stopFailed: stop createNewPrimary and report an error
- createNode <decimal nodeId>
  Request the class information for the specified node, and create a FHEM device upon reception of the answer. Used to create FHEM devices for nodes included with another software or if the fhem.cfg got lost. For the node id see the get nodeList command below. Note: the node must be "alive", i.e. for battery based devices you have to press the "wakeup" button 1-2 seconds before entering this command in FHEM.
- factoryReset yes
  Reset controller to default state. Erase all node and routing infos, assign a new random homeId. To control a device it must be re-included and re-configured.
  !Use this with care AND only if You know what You do!
  Note: the corresponding FHEM devices have to be deleted manually.
- learnMode on|onNw|disable
  Add or remove controller to/from an other network. Assign a homeId, nodeId and receive/store nodeList and routing infos.
- removeFailedNode <decimal nodeId>
  Remove non-responding node -that must be on the failed node list- from the routing table in controller. Instead, always use removeNode if possible. Note: the corresponding FHEM device have to be deleted manually.
- removeNode onNw|on|off
  Activate (or deactivate) exclusion mode. "on" activates standard exclusion. "onNw" activates network wide exclusion (only SDK 4.5-4.9, SDK 6.x and above). Note: the corresponding FHEM device have to be deleted manually.
- reopen
  First close and then open the device. Used for debugging purposes.
- replaceFailedNode <decimal nodeId>
  Replace a non-responding node with a new one. The non-responding node must be on the failed node list.
- sucNodeId <decimal nodeId> <sucState> <capabilities>
  <Configure a controller node to be a SUC/SIS or not.
  <nodeId>: decimal nodeId to be SUC/SIS
  <sucState>: 0 = deactivate; 1 = activate
  <capabilities>: 0 = basic SUC; 1 = SIS
- sucRequestUpdate <decimal nodeId of SUC/SIS>
  Request network updates from SUC/SIS. Primary do not need it.
- sucSendNodeId <decimal nodeId>
  Send SUC/SIS nodeId to the specified decimal controller nodeId.

Get

- homeId
  return the six hex-digit homeId of the controller.
- isFailedNode <decimal nodeId>
  return if a node is stored in the failed node list.
- caps, ctrlCaps, version
  return different controller specific information. Needed by developers only.
- neighborList [excludeDead] [onlyRep] <decimal nodeId>
  return neighborList of the decimal nodeId.
  With onlyRep the result will include only nodes with repeater functionality.
- nodeInfo <decimal nodeId>
  return node specific information. Needed by developers only.
- nodeList
  return the list of included nodenames or UNKNOWN_id (decimal id), if there is no corresponding device in FHEM. Can be used to recreate FHEM-nodes with the createNode command.
- random <N>
  request <N> random bytes from the controller.
- raw <hex>
  Send raw data <hex> to the controller. Developer only.
- routeFor node
  request priority routing for node
- sucNodeId
  return the currently registered decimal SUC nodeId.

Attributes

- dummy
- do_not_notify
- model
- disable
- helpSites
  Comma separated list of Help Sites to get device pictures from or to show a link to in the detailed window. Valid values are pepper and alliance.
- homeId
  Stores the homeId of the dongle. Is a workaround for some buggy dongles, wich sometimes report a wrong/nonexisten homeId (Forum #35126)
- networkKey
  Needed for secure inclusion, hex string with length of 32
- neighborListPos
  Used by the "Show neighbor map" function in the FHEMWEB ZWDongle detail screen to store the position of the box.
- neighborListFmt
  Used by the "Show neighbor map" function in the FHEMWEB ZWDongle detail screen. The value is a perl hash, specifiying the values for the keys txt, img and title. In the value each word is replaced by the corresponding Internal, Reading or Attribute of the device, if there is one to replace. Default is
  `{ txt=>"NAME", img=>"IMAGE", title=>"Time to ack: timeToAck" }`

Generated events:

General
- UNDEFINED ZWave_${type6}_$id ZWave $homeId $id $classes
- ZW_APPLICATION_UPDATE addDone $nodeId
- ZW_APPLICATION_UPDATE deleteDone $nodeId
- ZW_APPLICATION_UPDATE sudId $nodeId
addNode
- ZW_ADD_NODE_TO_NETWORK [learnReady|nodeFound|slave|controller| done|failed]
controllerChange
- ZW_CONTROLLER_CHANGE [learnReady|nodeFound|controller|done|failed]
createNewPrimary
- ZW_CREATE_NEW_PRIMARY [learnReady|nodeFound|controller|done|failed]
factoryReset
- ZW_SET_DEFAULT [done]
learnMode
- ZW_SET_LEARN_MODE [started|done|failed|deleted]
neighborUpdate
- ZW_REQUEST_NODE_NEIGHBOR_UPDATE [started|done|failed]
removeFailedNode
- ZW_REMOVE_FAILED_NODE_ID [failedNodeRemoveStarted|notPrimaryController|noCallbackFunction| failedNodeNotFound|failedNodeRemoveProcessBusy| failedNodeRemoveFail|nodeOk|nodeRemoved|nodeNotRemoved]
removeNode
- ZW_REMOVE_NODE_FROM_NETWORK [learnReady|nodeFound|slave|controller|done|failed]
replaceFailedNode
- ZW_REPLACE_FAILED_NODE [failedNodeRemoveStarted|notPrimaryController|noCallbackFunction| failedNodeNotFound|failedNodeRemoveProcessBusy| failedNodeRemoveFail|nodeOk|failedNodeReplace| failedNodeReplaceDone|failedNodeRemoveFailed]
sucNetworkUpdate
- ZW_REQUEST_NETWORK_UPDATE [started|selfOrNoSUC|done|abort|wait|diabled| overflow]
sucNodeId
- ZW_SET_SUC_NODE_ID [ok|failed|callbackSucceeded|callbackFailed]
sucRouteAdd
- ZW_ASSIGN_SUC_RETURN_ROUTE [started|alreadyActive|transmitOk| transmitNoAck|transmitFail|transmitNotIdle| transmitNoRoute]
sucRouteDel
- ZW_DELETE_SUC_RETURN_ROUTE [started|alreadyActive|transmitOk| transmitNoAck|transmitFail|transmitNotIdle| transmitNoRoute]
sucSendNodeId
- ZW_SEND_SUC_ID [started|alreadyActive|transmitOk| transmitNoAck|transmitFail|transmitNotIdle| transmitNoRoute]

### ZWave

This module is used to control ZWave devices via FHEM, see www.z-wave.com on details for this device family. This module is a client of the ZWDongle module, which is directly attached to the controller via USB or TCP/IP. To use the SECURITY features, the Crypt-Rijndael perl module is needed.
Define

`define <name> ZWave <homeId> <id> [classes]`
<homeId> is the homeId of the controller node, and id is the id of the slave node in the network of this controller.
classes is a hex-list of ZWave device classes. This argument is usually specified by autocreate when creating a device. If you wish to manually create a device, use the classes attribute instead, see below for details. Defining a ZWave device the first time is usually done by autocreate.
Example:

`define lamp ZWave 00ce2074 9`
`attr lamp classes SWITCH_BINARY BASIC MANUFACTURER_SPECIFIC VERSION SWITCH_ALL ASSOCIATION METER CONFIGURATION ALARM`

Note: the sets/gets/generated events of a given node depend on the classes supported by this node. If a node supports 3 classes, then the union of these sets/gets/events will be available for this node.
Commands for battery operated nodes will be queues internally, and sent when the node sends a message. Answer to get commands appear then as events, the corresponding readings will be updated.
Set

Note: devices with on/off functionality support the set extensions.
All
- neighborUpdate
  Requests controller to update his routing table which is based on slave's neighbor list. The update may take significant time to complete. With the event "done" or "failed" ZWDongle will notify the end of the update process. To read node's neighbor list see neighborList get below.
- returnRouteAdd <decimal nodeId>
  Assign up to 4 static return routes to the routing/enhanced slave to allow direct communication to <decimal nodeId>. (experts only)
- returnRouteDel
  Delete all static return routes. (experts only)
- sucRouteAdd
  Inform the routing/enhanced slave of the presence of a SUC/SIS. Assign up to 4 static return routes to SUC/SIS.
- sucRouteDel
  Delete static return routes to SUC/SIS node.
Class ALARM
- alarmnotification <alarmType> (on|off)
  Enable (on) or disable (off) the sending of unsolicited reports for the alarm type <alarmType>. A list of supported alarm types of the device can be obtained with the alarmTypeSupported command. The name of the alarm type is case insensitive. Sending of an unsolicted notification only works to associated nodes, broadcasting is not allowed, so associations have to be set up. This command is specified in version 2.
- Note:
  The name of the class ALARM was renamed to NOTIFICATION in version 3 of the Zwave specification. Due to backward compatibility reasons the class will be always referenced as ALARM in FHEM, regardless of the version.
Class ASSOCIATION
- associationAdd groupId nodeId ...
  Add the specified list of nodeIds to the association group groupId.
  Note: upon creating a fhem-device for the first time fhem will automatically add the controller to the first association group of the node corresponding to the fhem device, i.e it issues a "set name associationAdd 1 controllerNodeId"
- associationDel groupId nodeId ...
  Remove the specified list of nodeIds from the association group groupId.
Class BASIC
- basicValue value
  Send value (0-255) to this device. The interpretation is device dependent, e.g. for a SWITCH_BINARY device 0 is off and anything else is on.
- basicValue value
  Alias for basicValue, to make mapping from the incoming events easier.
Class BASIC_WINDOW_COVERING
- coveringClose
  Starts closing the window cover. Moving stops if blinds are fully closed or a coveringStop command was issued.
- coveringOpen
  Starts opening the window cover. Moving stops if blinds are fully open or a coveringStop command was issued.
- coveringStop
  Stop moving the window cover. Blinds are partially open (closed).
Class CLIMATE_CONTROL_SCHEDULE
- ccs [mon|tue|wed|thu|fri|sat|sun] HH:MM tempDiff HH:MM tempDiff ...
  set the climate control schedule for the given day.
  Up to 9 pairs of HH:MM tempDiff may be specified.
  HH:MM must occur in increasing order. tempDiff is relative to the setpoint temperature, and may be between -12 and 12, with one decimal point, measured in Kelvin (or Centigrade).
  If only a weekday is specified without any time and tempDiff, then the complete schedule for the specified day is removed and marked as unused.
- cssSetOverride (no|temporary|permanent) (frost|energy|$tempOffset)
  set the override state
  no: switch the override off
  temporary: override the current schedule only
  permanent: override all schedules
  frost/energy: set override mode to frost protection or engergy saving
  $tempOffset: the temperature setback (offset to setpoint) in 1/10 degrees
  range from -12.8 to 12.0, values will be limited to this range.
Class CLOCK
- clock
  set the clock to the current date/time (no argument required)
Class COLOR_CONTROL
- rgb
  Set the color of the device as a 6 digit RGB Value (RRGGBB), each color is specified with a value from 00 to ff.
- wcrgb
  Used for sending warm white, cold white, red, green and blue values to device. Values must be decimal (0 - 255) and separated by blanks.
  set <name> wcrgb 0 255 0 0 0 (setting full cold white)
Class CONFIGURATION
- configByte cfgAddress 8bitValue
  configWord cfgAddress 16bitValue
  configLong cfgAddress 32bitValue
  Send a configuration value for the parameter cfgAddress. cfgAddress and value is node specific.
  Note: if the model is set (see MANUFACTURER_SPECIFIC get), then more specific config commands are available.
- configDefault cfgAddress
  Reset the configuration parameter for the cfgAddress parameter to its default value. See the device documentation to determine this value.
Class DOOR_LOCK, V2
- doorLockOperation DOOR_LOCK_MODE
  Set the operation mode of the door lock.
  DOOR_LOCK_MODE:
  open = Door unsecured
  close = Door secured
  00 = Door unsecured
  01 = Door unsecured with timeout
  10 = Door unsecured for inside door handles
  11 = Door unsecured for inside door handles with timeout
  20 = Door unsecured for outside door handles
  21 = Door unsecured for outside door handles with timeout
  FF = Door secured
  Note: open/close can be used as an alias for 00/FF.
- doorLockConfiguration operationType outsidehandles insidehandles timeoutSeconds
  Set the configuration for the door lock.
  operationType: [constant|timed]
  outsidehandle/insidehandle: 4-bit binary field for handle 1-4, bit=0:handle disabled, bit=1:handle enabled, highest bit is for handle 4, lowest bit for handle 1. Example 0110 0001 = outside handles 3 and 2 are active, inside handle 1 is active
  timeoutSeconds: time out for timed operation (in seconds) [1-15239].
Class INDICATOR
- indicatorOn
  switch the indicator on
- indicatorOff
  switch the indicator off
- indicatorDim value
  takes values from 1 to 99. If the indicator does not support dimming. It is interpreted as on.
Class MANUFACTURER_PROPRIETARY
Fibaro FGR(M)-222 only:
- positionBlinds
  drive blinds to position %
- positionSlat
  drive slat to position %
D-Link DCH-Z510, Philio PSE02, Zipato Indoor Siren only:
switch alarm on with selected sound (to stop use: set <device> off)
- alarmEmergencyOn
- alarmFireOn
- alarmAmbulanceOn
- alarmPoliceOn
- alarmDoorchimeOn
- alarmBeepOn
Class METER
- meterReset
  Reset all accumulated meter values.
  Note: see meterSupported command and its output to detect if resetting the value is supported by the device.
  The command will reset ALL accumulated values, it is not possible to choose a single value.
Class MULTI_CHANNEL
- mcCreateAll
  Create a FHEM device for all channels. This command is executed after inclusion of a new device.
Class MULTI_CHANNEL_ASSOCIATION
- mcaAdd groupId node1 node2 ... 0 node1 endPoint1 node2 endPoint2 ...
  Add a list of node or node:endpoint associations. The latter can be used to create channels on remotes. E.g. to configure the button 1,2,... on the zwave.me remote, use:
  set remote mcaAdd 2 0 1 2
  set remote mcaAdd 3 0 1 3
  ....
  For each button a separate FHEM device will be generated.
- mcaDel groupId node1 node2 ... 0 node1 endPoint1 node2 endPoint2 ...
  delete node or node:endpoint associations. Special cases: just specifying the groupId will delete everything for this groupId. Specifying 0 for groupid will delete all associations.
Class NETWORK_SCHEDULE (SCHEDULE), V1
- schedule ID USER_ID YEAR-MONTH-DAY WDAY ACTIVE_ID DURATION_TYPE HOUR:MINUTE DURATION NUM_REPORTS CMD ... CMD
  Set a schedule for a user. Due to lack of documentation, details for some parameters are not available. Command Class is used together with class USER_CODE.
  ID: id of schedule, refer to maximum number of supported schedules reported by the scheduleSupported command.
  USER_ID: id of user, starting from 1 up to the number of supported users, refer also to the USER_CODE class description.
  YEAR-MONTH-DAY: start of schedule in the format yyyy-mm-dd.
  WDAY: weekday, 1=Monday, 7=Sunday.
  ACTIVE_ID: unknown parameter.
  DURATION_TYPE: unknown parameter.
  HOUR:MINUTE: start of schedule in the format hh:mm.
  DURATION: unknown parameter.
  NUM_REPORTS: number of reports to follow, must be 0.
  CMD: command(s) (as hexcode sequence) that the schedule executes, see report of scheduleSupported command for supported command class and mask. A list of space separated command can be specified.
- scheduleRemove ID
  Remove the schedule with the id ID
- scheduleState ID STATE
  Set the STATE of the schedule with the id ID. Description for parameter STATE is not available.
Class NODE_NAMING
- name NAME
  Store NAME in the EEPROM. Note: only ASCII is supported.
- location LOCATION
  Store LOCATION in the EEPROM. Note: only ASCII is supported.
Class POWERLEVEL
- Class is only used in an installation or test situation
- powerlevel level timeout/s
  set powerlevel to level [0-9] for timeout/s [1-255].
  level 0=normal, level 1=-1dBm, .., level 9=-9dBm.
- powerlevelTest nodeId level frames
  send number of frames [1-65535] to nodeId with level [0-9].
Class PROTECTION
- protectionOff
  device is unprotected
- protectionOn
  device is protected
- protectionSeq
  device can be operated, if a certain sequence is keyed.
- protectionBytes LocalProtectionByte RFProtectionByte
  for commandclass PROTECTION V2 - see devicemanual for supported protectionmodes
Class SCENE_ACTIVATION
- sceneConfig
  activate settings for a specific scene. Parameters are: sceneId, dimmingDuration (0..255)
Class SCENE_ACTUATOR_CONF
- sceneConfig
  set configuration for a specific scene. Parameters are: sceneId, dimmingDuration, finalValue (0..255)
Class SCENE_CONTROLLER_CONF
- groupConfig
  set configuration for a specific scene. Parameters are: groupId, sceneId, dimmingDuration.
Class SCHEDULE_ENTRY_LOCK, V1, V2, V3
- scheduleEntryLockSet USER_ID ENABLED
  enables or disables schedules for a specified user ID (V1)
  USER_ID: id of user, starting from 1 up to the number of supported users, refer also to the USER_CODE class description.
  ENABLED: 0=disabled, 1=enabled
- scheduleEntryLockAllSet ENABLED
  enables or disables schedules for all users (V1)
  ENABLED: 0=disabled, 1=enabled
- scheduleEntryLockWeekDaySet ACTION USER_ID SCHEDULE_ID WEEKDAY STARTTIME ENDTIME
  erase or set a week day schedule for a specified user ID (V1)
  ACTION: 0=erase schedule slot, 1=modify the schedule slot for the user
  USER_ID: id of user, starting from 1 up to the number of supported users, refer also to the USER_CODE class description.
  SCHEDULE_ID: schedule slot id (from 1 up to number of supported schedule slots)
  WEEKDAY: day of week, choose one of: "sun","mon","tue","wed","thu","fri","sat"
  STARTTIME: time of schedule start, in the format HH:MM (leading 0 is mandatory)
  ENDTIME: time of schedule end in the format HH:MM (leading 0 is mandatory)
- scheduleEntryLockYearDaySet ACTION USER_ID SCHEDULE_ID STARTDATE STARTTIME ENDDATE ENDTIME
  erase or set a year day schedule for a specified user ID (V1)
  ACTION: 0=erase schedule slot, 1=modify the schedule slot for the user
  USER_ID: id of user, starting from 1 up to the number of supported users, refer also to the USER_CODE class description.
  SCHEDULE_ID: schedule slot id (from 1 up to number of supported schedule slots)
  STARTDATE: date of schedule start in the format YYYY-MM-DD
  STARTTIME: time of schedule start in the format HH:MM (leading 0 is mandatory)
  ENDDATE: date of schedule end in the format YYYY-MM-DD
  ENDTIME: time of schedule end in the format HH:MM (leading 0 is mandatory)
- scheduleEntryLockTimeOffsetSet TZO DST
  set the TZO and DST (V2)
  TZO: current local time zone offset in the format (+|-)HH:MM (sign and leading 0 is mandatory)
  DST: daylight saving time offset in the format (+|-)[[m]m]m (sign is mandatory, minutes: 0 to 127, 1-3 digits)
- scheduleEntryLockDailyRepeatingSet ACTION USER_ID SCHEDULE_ID WEEKDAYS STARTTIME DURATION
  set a daily repeating schedule for the specified user (V3)
  ACTION: 0=erase schedule slot, 1=modify the schedule slot for the user
  USER_ID: id of user, starting from 1 up to the number of supported users, refer also to the USER_CODE class description.
  SCHEDULE_ID: schedule slot id (from 1 up to number of supported schedule slots)
  WEEKDAYS: concatenated string of weekdays (choose from: "sun","mon","tue","wed","thu","fri","sat"); e.g. "montuewedfri" or "satsun", unused days can be specified as "..."
  STARTTIME: time of schedule start in the format HH:MM (leading 0 is mandatory)
  DURATION: duration of schedule in the format HH:MM (leading 0 is mandatory)
Class SWITCH_ALL
- swaIncludeNone
  the device does not react to swaOn and swaOff commands
- swaIncludeOff
  the device reacts to the swaOff command but does not react to the swaOn command
- swaIncludeOn
  the device reacts to the swaOn command but does not react to the swaOff command
- swaIncludeOnOff
  the device reacts to the swaOn and swaOff commands
- swaOn
  sends the all on command to the device
- swaOff
  sends the all off command to the device.
Class SWITCH_BINARY
- on
  switch the device on
- off
  switch the device off
Class SWITCH_MULTILEVEL
- on, off
  the same as for SWITCH_BINARY.
- dim value
  dim/jump to the requested value (0..100)
- dimWithDuration value duration
  dim to the requested value (0..100) in duration time. If duration is less than 128, then it is interpreted as seconds, if it is between 128 and 254, then as duration-128 minutes. Note: this command works only with devices supporting version 2 of the SWITCH_MULTILEVEL class, which you can verify with get versionClassAll
- stop
  stop dimming/operation
Class THERMOSTAT_MODE
- tmOff
- tmEnergySaveHeating
- tmHeating
- tmManual
  set the thermostat mode to off, heating but saving energy, heating or manual.
Class THERMOSTAT_SETPOINT
- setpointHeating value
  set the thermostat to heat to the given value. The value is a whole number and read as celsius.
  See thermostatSetpointSet for a more enhanced method.
- setpointCooling value
  set the thermostat to heat to the given value. The value is a whole number and read as celsius.
  See thermostatSetpointSet for a more enhanced method.
- thermostatSetpointSet TEMP [SCALE [TYPE [PREC [SIZE]]]]
  set the setpoint of the thermostat to the given value.
  TEMP: setpoint temperature value, by default the value is used with 1 decimal, see PREC
  SCALE: (optional) scale of temperature; [cC]=celsius, [fF]=fahrenheit, defaults to celsius
  TYPE: (optional) setpoint type; [1, 15], defaults to 1=heating
  1=heating, 2=cooling, 7=furnance, 8=dryAir, 9=moistAir, 10=autoChangeover, 11=energySaveHeating, 12=energySaveCooling, 13=awayHeating, 14=awayCooling, 15=fullPower
  PREC: (optional) number of decimals to be used, [1-7], defaults to 1
  SIZE: (optional) number of bytes used, [1, 2, 4], defaults to 2
  Note: optinal parameters can be ommitted and are used with there default values. If you need or want to specify an optional parameter, ALL parameters in front of this parameter need to be also specified!
  Note: the number of decimals (defined by PREC) and the number of bytes (defined by SIZE) used for the setpoint influence the usable range for the temperature. Some device do not support all possible values/combinations for PREC/SIZE.
  1 byte: 0 decimals [-128, 127], 1 decimal [-12.8, 12.7], ...
  2 byte: 0 decimals [-32768, 32767], 1 decimal [-3276.8, 3276.7], ...
  4 byte: 0 decimals [-2147483648, 2147483647], ...
- desired-temp value
  same as thermostatSetpoint, used to make life easier for helper-modules like
Class TIME, V2
- timeOffset TZO DST_Offset DST_START DST_END
  Set the time offset for the internal clock of the device.
  TZO: Offset of time zone to UTC in format [+|-]hh:mm.
  DST_OFFSET: Offset for daylight saving time (DST) in minutes in the format [+|-]mm.
  DST_START / DST_END: Start and end of daylight saving time in the format MM-DD_HH:00.
  Note: Sign for both offsets must be specified!
  Note: Minutes for DST_START and DST_END must be specified as "00"!
Class TIME_PARAMETERS, V1
- timeParametersGet
  The device request time parameters. Right now the user should define a notify with a "set timeParameters" command.
- timeParameters DATE TIME
  Set the time (UTC) to the internal clock of the device.
  DATE: Date in format YYYY-MM-DD.
  TIME: Time (UTC) in the format hh:mm:ss.
  Note: Time zone offset to UTC must be set with command class TIME.
Class USER_CODE
- userCode id status code set code and status for the id n. n ist starting at 1, status is 0 for available (deleted) and 1 for set (occupied). code is a hexadecimal string.
Class WAKE_UP
- wakeupInterval value nodeId
  Set the wakeup interval of battery operated devices to the given value in seconds. Upon wakeup the device sends a wakeup notification to nodeId.
- wakeupNoMoreInformation
  put a battery driven device into sleep mode.

Get

All
- neighborList
  returns the list of neighbors. Provides insights to actual network topology. List includes dead links and non-routing neighbors. Since this information is stored in the dongle, the information will be returned directly even for WAKE_UP devices.
Class ALARM
- alarm <alarmId>
  return the value for the (decimal) alarmId. The value is device specific. This command is specified in version 1 and should only be used with old devices that only support version 1.
- alarmWithType <alarmType>
  return the event for the specified alarm type. This command is specified in version 2.
- alarmWithTypeEvent <alarmType> <eventnumber>
  return the event details for the specified alarm type and eventnumber. This command is specified in version 3. The eventnumber is specific for each alarm type, a list of the supported eventnumbers can be obtained by the "alarmEventSupported" command, refer also to the documentation of the device.
- alarmTypeSupported
  Returns a list of the supported alarm types of the device which are used as parameters in the "alarmWithType" and "alarmWithTypeEvent" commands. This command is specified in version 2.
- alarmEventSupported <alarmType>
  Returns a list of the supported events for the specified alarm type. The number of the events can be used as parameter in the "alarmWithTypeEvent" command. This command is specified in version 3.
Class ASSOCIATION
- association groupId
  return the list of nodeIds in the association group groupId in the form:
  assocGroup_X:Max Y, Nodes id,id...
- associationGroups
  return the number of association groups
- associationAll
  request association info for all possible groups.
Class ASSOCIATION_GRP_INFO
- associationGroupName groupId
  return the name of association groups
- associationGroupCmdList groupId
  return Command Classes and Commands that will be sent to associated devices in this group
Class BASIC
- basicStatus
  return the status of the node as basicReport:XY. The value (XY) depends on the node, e.g a SWITCH_BINARY device report 00 for off and FF (255) for on. Devices with version 2 (or greater) can return two additional values, the 'target value' and 'duration'. The 'duration' is reported in seconds, as "unknown duration" (value 0xFE = 253) or as "255 (reserved value)" (value 0xFF = 255).
Class BATTERY
- battery
  return the charge of the battery in %, as battery:value % or battery:low
Class CLIMATE_CONTROL_SCHEDULE
- ccsOverride
  request the climate control schedule override report
- ccs [mon|tue|wed|thu|fri|sat|sun]
  request the climate control schedule for the given day.
- ccsAll
  request the climate control schedule for all days. (runs in background)
Class CLOCK
- clock
  request the clock data
Class COLOR_CONTROL
- ccCapability
  return capabilities.
- ccStatus channelId
  return status of channel ChannelId.
Class CONFIGURATION
- config cfgAddress
  return the value of the configuration parameter cfgAddress. The value is device specific.
  Note: if the model is set (see MANUFACTURER_SPECIFIC get), then more specific config commands are available.
- configAll
  If the model of a device is set, and configuration descriptions are available from the database for this device, then request the value of all known configuration parameters.
Class DOOR_LOCK, V2
- doorLockConfiguration
  Request the configuration report from the door lock.
- doorLockOperation
  Request the operconfiguration report from the door lock.
Class HRV_STATUS
- hrvStatus
  report the current status (temperature, etc)
- hrvStatusSupported
  report the supported status fields as a bitfield.
Class INDICATOR
- indicatorStatus
  return the indicator status of the node, as indState:on, indState:off or indState:dim value.
Class MANUFACTURER_PROPRIETARY
- position
  Fibaro FGRM-222 only: return the blinds position and slat angle.
Class MANUFACTURER_SPECIFIC
- model
  return the manufacturer specific id (16bit), the product type (16bit) and the product specific id (16bit).
  Note: if the openzwave xml files are installed, then return the name of the manufacturer and of the product. This call is also necessary to decode more model specific configuration commands and parameters.
Class METER
- meter scale
  return the meter report for the requested scale.
  Note: protocol V1 does not support the scale parameter, the parameter will be ignored and the default scale will be returned.
  For protocol V2 and higher, scale is supported and depends on the type of the meter (energy, gas or water).
  The device may not support all scales, see the meterSupported command and its output. If the scale parameter is omitted, the default unit will be reported.
  Example: For an electric meter, meter 0 will report energy in kWh, meter 2 will report power in W and meter 6 will report current in A (if these scales are supported).
- meterSupported
  request the type of the meter, the supported scales and the capability to reset the accumulated value.
  Note: The output contains the decimal numbers of the supported scales that can be used as parameter for the meter command.
Class MULTI_CHANNEL
- mcEndpoints
  return the list of endpoints available, e.g.:
  mcEndpoints: total 2, identical
- mcCapability chid
  return the classes supported by the endpoint/channel chid. If the channel does not exists, create a FHEM node for it. Example:
  mcCapability_02:SWITCH_BINARY
  Note: This is the best way to create the secondary nodes of a MULTI_CHANNEL device. The device is only created for channel 2 or greater.
Class MULTI_CHANNEL_ASSOCIATION
- mca groupid
  return the associations for the groupid. for the syntax of the returned data see the mcaAdd command above.
- mcaAll
  request association info for all possible groupids.
Class NETWORK_SCHEDULE (SCHEDULE), V1
- scheduleSupported
  Request the supported features, e.g. number of supported schedules. Due to the lack of documentation, details for some fields in the report are not available.
- schedule ID
  Request the details for the schedule with the id ID. Due to the lack of documentation, details for some fields in the report are not available.
- scheduleState
  Request the details for the schedule state. Due to the lack of documentation, details for some fields in the report are not available.
Class NODE_NAMING
- name
  Get the name from the EEPROM. Note: only ASCII is supported.
- location
  Get the location from the EEPROM. Note: only ASCII is supported.
Class POWERLEVEL
- powerlevel
  Get the current powerlevel and remaining time in this level.
- powerlevelTest
  Get the result of last powerlevelTest.
Class PROTECTION
- protection
  returns the protection state. It can be on, off or seq.
Class SCENE_ACTUATOR_CONF
- sceneConfig
  returns the settings for a given scene. Parameter is sceneId
Class SCENE_CONTROLLER_CONF
- groupConfig
  returns the settings for a given group. Parameter is groupId
Class SCHEDULE_ENTRY_LOCK, V1, V2, V3
- scheduleEntryLockTypeSupported
  returns the number of available slots for week day and year day schedules (V1), in V3 the number of available slots for the daily repeating schedule is reported additionally
- scheduleEntryLockWeekDay USER_ID SCHEDULE_ID
  returns the specified week day schedule for the specified user (day of week, start time, end time) (V1)
  USER_ID: id of user, starting from 1 up to the number of supported users, refer also to the USER_CODE class description.
  SCHEDULE_ID: schedule slot id (from 1 up to number of supported schedule slots)
- scheduleEntryLockYearDay USER_ID SCHEDULE_ID
  returns the specified year day schedule for the specified user (start date, start time, end date, end time) (V1)
  USER_ID: id of user, starting from 1 up to the number of supported users, refer also to the USER_CODE class description.
  SCHEDULE_ID: schedule slot id (from 1 up to number of supported schedule slots)
- scheduleEntryLockDailyRepeating USER_ID SCHEDULE_ID
  returns the specified daily schedule for the specified user (weekdays, start date, duration) (V3)
  USER_ID: id of user, starting from 1 up to the number of supported users, refer also to the USER_CODE class description.
  SCHEDULE_ID: schedule slot id (from 1 up to number of supported schedule slots)
- scheduleEntryLockTimeOffset
  returns the time zone offset TZO and the daylight saving time offset (V2)
Class SECURITY
- secSupportedReport
  (internaly used to) request the command classes that are supported with SECURITY
- Notes:
  This class needs the installation of the perl module Crypt::Rijndael and a defined networkkey in the attributes of the ZWDongle device
  Currently a secure inclusion can only be started from the command input with "set <ZWDongle_device_name> addNode [onSec|onNwSec]"
  These commands are only described here for completeness of the documentation, but are not intended for manual usage. These commands will be removed from the interface in future version.
Class SENSOR_ALARM
- alarm alarmType
  return the nodes alarm status of the requested alarmType. 00 = GENERIC, 01 = SMOKE, 02 = CO, 03 = CO2, 04 = HEAT, 05 = WATER, 255 = returns the nodes first supported alarm type.
Class SENSOR_BINARY
- sbStatus
  return the status of the node.
Class SENSOR_MULTILEVEL
- smStatus
  request data from the node (temperature/humidity/etc)
Class SWITCH_ALL
- swaInclude
  return the switch-all mode of the node.
Class SWITCH_BINARY
- swbStatus
  return the status of the node, as state:on or state:off.
Class SWITCH_MULTILEVEL
- swmStatus
  return the status of the node, as state:on, state:off or state:dim value.
Class THERMOSTAT_MODE
- thermostatMode
  request the mode
Class THERMOSTAT_SETPOINT
- setpoint [TYPE]
  request the setpoint
  TYPE: (optional) setpoint type; [1, 15], defaults to 1=heating
  1=heating, 2=cooling, 7=furnance, 8=dryAir, 9=moistAir, 10=autoChangeover, 11=energySaveHeating, 12=energySaveCooling, 13=awayHeating, 14=awayCooling, 15=fullPower
- thermostatSetpointSupported
  requests the list of supported setpoint types
Class TIME, V2
- time
  Request the (local) time from the internal clock of the device.
- date
  Request the (local) date from the internal clock of the device.
- timeOffset
  Request the report for the time offset and DST settings from the internal clock of the device.
Class TIME_PARAMETERS, V1
- time
  Request the date and time (UTC) from the internal clock of the device.
Class USER_CODE
- userCode n request status and code for the id n
Class VERSION
- version
  return the version information of this node in the form:
  Lib A Prot x.y App a.b
- versionClass classId or className
  return the supported command version for the requested class
- versionClassAll
  executes "get devicename versionClass class" for each class from the classes attribute in the background without generating events, and sets the vclasses attribute at the end.
Class WAKE_UP
- wakeupInterval
  return the wakeup interval in seconds, in the form
  wakeupReport:interval seconds target id
- wakeupIntervalCapabilities (V2 only)
  return the wake up interval capabilities in seconds, in the form
  wakeupIntervalCapabilitiesReport:min seconds max seconds default seconds step seconds
Class ZWAVEPLUS_INFO
- zwavePlusInfo
  request the zwavePlusInfo

Attributes

- IODev
- WNMI_delay
  This attribute set the time delay between the last message sent to an WakeUp device and the sending of the WNMI Message (WakeUpNoMoreInformation) that will set the device to sleep mode. Value is in seconds, subseconds my be specified. Values outside of 0.2-5.0 are probably harmful.
- classes
  This attribute is needed by the ZWave module, as the list of the possible set/get commands depends on it. It contains a space separated list of class names (capital letters).
- do_not_notify
- dummy
- eventForRaw
  Generate an an additional event for the RAW message. Can be used if someone fears that critical notifies wont work, if FHEM changes the event text after an update.
- extendedAlarmReadings
  Some devices support more than one alarm type, this attribute selects which type of reading is used for the reports of the ALARM (or NOTIFICATION) class:
  A value of "0" selects a combined, single reading ("alarm") for all alarm types of the device. Subsequent reports of different alarm types will overwrite each other. This is the default setting and the former behavior.
  A value of "1" selects separate alarm readings for each alarm type of the device. The readings are named "alarm_<alarmtype>. This can also be selected if only one alarmtype is supported by the device. This reading also contains the status of the alarm notification. For compatibility reasons this is currently not supported with the combined reading.
  A value of "2" selects both of the above and creates the combined and the seperate readings at the same time, this should only be used if really needed as duplicate events are generated.
- ignore
- ignoreDupMsg
  Experimental: if set (to 1), ignore duplicate wakeup messages, or multiple responses to a single get due to missing lowlevel ACK.
- neighborListPos
- noExplorerFrames
  turn off the use of Explorer Frames
- noWakeupForApplicationUpdate
  some devices (notable the Aeotec Multisensor 6) are only awake after an APPLICATION UPDATE telegram for a very short time. If this attribute is set (recommended for the Aeotec Multisensor 6), the WakeUp-Stack is not processed after receiving such a message.
- readingFnAttributes
- secure_classes
  This attribute is the result of the "set DEVICE secSupportedReport" command. It contains a space seperated list of the the command classes that are supported with SECURITY.
- showtime
- vclasses
  This is the result of the "get DEVICE versionClassAll" command, and contains the version information for each of the supported classes.
- useMultiCmd
  Experimental: if a device supports MULTI_CMD and WAKE_UP, then pack multiple get messages on the SendStack into a single MULTI_CMD to save radio transmissions.
- zwaveRoute
  space separated list of (ZWave) device names. They will be used in the given order to route messages from the controller to this device. Specify them in the order from the controller to the device. Do not specify the controller and the device itself, only the routers inbetween. Used only if the IODev is a ZWCUL device.

Generated events:

neighborUpdate
- ZW_REQUEST_NODE_NEIGHBOR_UPDATE [started|done|failed]
returnRouteAdd
- ZW_ASSIGN_RETURN_ROUTE [started|alreadyActive|transmitOk| transmitNoAck|transmitFail|transmitNotIdle| transmitNoRoute]
returnRouteDel
- ZW_DELETE_RETURN_ROUTE [started|alreadyActive|transmitOk| transmitNoAck|transmitFail|transmitNotIdle| transmitNoRoute]
sucRouteAdd
- ZW_ASSIGN_SUC_RETURN_ROUTE [started|alreadyActive|transmitOk| transmitNoAck|transmitFail|transmitNotIdle| transmitNoRoute]
sucRouteDel
- ZW_DELETE_SUC_RETURN_ROUTE [started|alreadyActive|transmitOk| transmitNoAck|transmitFail|transmitNotIdle| transmitNoRoute]
Class ALARM
- Note:
  Depending on the setting of the attribute "extendedAlarmReadings" the generated events differ slightly. With a value of "0" or "2" a combined reading for all alarm types of the device with the name "alarm" will be used. With a value of "1" or "2" separate readings for each supported alarm type will be generated with names "alarm_<alarmType>.
- Devices with class version 1 support: alarm_type_X:level Y
- For higher class versions more detailed events with 100+ different strings in the form alarm:<string> (or alarm_<alarmType>:<string>) are generated.
  For the combined reading, the name of the alarm type is part of the reading event, for separate readings it is part of the reading name.
  If a cleared event can be identified, the string "Event cleared:" is reported before the event details.
  The seperate readings also contain the status of the alarm / notification. For compatibility reasons this is currently not supported with the combined reading.
Class APPLICATION_STATUS
- applicationStatus: [cmdRejected]
- applicationBusy: [tryAgainLater|tryAgainInWaitTimeSeconds| RequestQueued|unknownStatusCode] $waitTime
Class ASSOCIATION
- assocGroup_X:Max Y Nodes A,B,...
- assocGroups:X
Class ASSOCIATION_GRP_INFO
- assocGroupName_X:name
- assocGroupCmdList_X:AABBCCDD...
Class BASIC
- basicReport:X (for version 1), basicReport:X target y duration z (for version 2 or greater)
- basicGet:request
- basicSet:X
Class BASIC_WINDOW_COVERING
- covering:[open|close|stop]
Class BATTERY
- battery:chargelevel %
Class CENTRAL_SCENE
- cSceneSet:X
- cSceneDim:X
- cSceneDimEnd:X
- cSceneDouble:X
- cSceneMultiple_N:X
  where N is 3, 4 or 5 (multiple presses)
Class CLIMATE_CONTROL_SCHEDULE
- ccsOverride:[no|temporary|permanent], [frost protection|energy saving|unused]
- ccsChanged:<number>
- ccs_[mon|tue|wed|thu|fri|sat|sun]:HH:MM temp HH:MM temp...
Class CLOCK
- clock:get
- clock:[mon|tue|wed|thu|fri|sat|sun] HH:MM
Class COLOR_CONTROL
- ccCapability:XY
- ccStatus_X:Y
Class CONFIGURATION
- config_X:Y
  Note: if the model is set (see MANUFACTURER_SPECIFIC get), then more specific config messages are available.
Class DEVICE_RESET_LOCALLY
- deviceResetLocally:yes
Class DOOR_LOCK, V2
- doorLockConfiguration: mode: [constant|timed] outsideHandles: $outside_mode(4 bit field) insideHandles: $inside_mode(4 bit field) timeoutSeconds: [not_supported|$seconds]
- doorLockOperation: mode: $mode outsideHandles: $outside_mode(4 bit field) insideHandles: $inside_mode(4 bit field) door: [open|closed] bolt: [locked|unlocked] latch: [open|closed] timeoutSeconds: [not_supported|$time]
  $mode = [unsecured|unsecured_withTimeout|unsecured_inside| unsecured_inside_withTimeout|unsecured_outside| unsecured_outside_withTimeout|secured
Class HAIL
- hail:01
Class HRV_STATUS
- outdoorTemperature: %0.1f C
- supplyAirTemperature: %0.1f C
- exhaustAirTemperature: %0.1f C
- dischargeAirTemperature: %0.1f C
- indoorTemperature: %0.1f C
- indoorHumidity: %s %
- remainingFilterLife: %s %
- supportedStatus: <list of supported stati>
Class INDICATOR
- indState:[on|off|dim value]
Class MANUFACTURER_PROPRIETARY
- Fibaro FGRM-222 with ReportsType Fibar CC only:
- position:Blind [%] Slat [%]
  (VenetianBlindMode)
- position:[%]
  (RollerBlindMode)
Class MANUFACTURER_SPECIFIC
- modelId:hexValue hexValue hexValue
- model:manufacturerName productName
- modelConfig:configLocation
Class METER
- energy:val [kWh|kVAh|pulseCount|powerFactor]
- gas:val [m3|feet3|pulseCount]
- water:val [m3|feet3|USgallons|pulseCount]
- power:val W
- voltage:val V
- current:val A
- meterSupported:type:[meter_type] scales:[list of supported scales] resetable:[yes|no]
Class MULTI_CHANNEL
- endpoints:total X $dynamic $identical
- mcCapability_X:class1 class2 ...
Class NETWORK_SCHEDULE (SCHEDULE), V1
- schedule_<id>: ID: $schedule_id userID: $user_id sYear: $starting_year sMonth: $starting_month activeID: $active_id sDay: $starting_day sWeekDay: $starting_weekday sHour: $starting_hour durationType: $duration_type sMinute: $starting_minute duration: $duration numReportsToFollow: $number_of_reports_to_follow numCmds: $number_of_commands cmdLen: $length_of_command cmd: $commandsequence(hex)
- scheduleSupported: num: $number_of_supported_schedules startTimeSupport: $start_time_support(6 bit field) fallbackSupport: $fallback_support enableDisableSupport: $ena_dis_support numCCs: $number_of_supported_command_classes overrideTypes: $override_types(7 bit field) overrideSupport: $override_support
- scheduleSupportedCC: CC_<x>: $number_of_command_class CCname_<x>: $name_of_command_class]CCmask_<x>: $mask_for_command(2 bit)
Class NODE_NAMING
- name:NAME
- location:LOCATION
Class POWERLEVEL
- powerlvl:current x remain y
  NOTE: "current 0 remain 0" means normal mode without timeout
- powerlvlTest:node x status y frameAck z
  NOTE: status 0=failed, 1=success (at least one ACK), 2=in progress
Class PROTECTION
- protection:[on|off|seq]
Class SCENE_ACTIVATION
- scene_Id:level finalValue
Class SCENE_ACTUATOR_CONF
- scene_Id:level dimmingDuration finalValue
Class SCENE_CONTROLLER_CONF
- group_Id:scene dimmingDuration
Class SCHEDULE_ENTRY_LOCK
- scheduleEntryLockEntryTypeSupported:WeekDaySlots: $value YearDaySlots: $value
- weekDaySchedule_$userId:userID: $value slotID: $value $weekday $starthour:$startminute $endhour:$endminute
- yearDaySchedule_$userId:userID: $value slotID: $value start: $year-$month-$day $hour:$minute end: $year-$month-$day $hour:$minute
- scheduleEntryLockDailyRepeating_$userId:userID: $value $weekdays $hour:$minute $durationhour:$durationminute
  Note: $weekdays is a concatenated string with weekdaynames ("sun","mon","tue","wed","thu","fri","sat") where inactive weekdays are represented by "...", e.g. montue...wedfri
- scheduleEntryLockTimeOffset:TZO: $sign$hour:$minute DST: $sign$minutes
Class SECURITY
- none
  Note: the class security should work transparent to the sytem and is not intended to generate events
Class SENSOR_ALARM
- alarm_type_X:level Y node $nodeID seconds $seconds
Class SENSOR_BINARY
- SENSORY_BINARY V1:
- state:open
- state:closed
- SENSORY_BINARY V2:
- unknown:[off|on]
- generalPurpose:[off|on]
- smoke:[off|on]
- CO:[off|on]
- CO2:[off|on]
- heat:[off|on]
- water:[off|on]
- freeze:[off|on]
- tamper:[off|on]
- aux:[off|on]
- doorWindow:[off|on]
- tilt:[off|on]
- motion:[off|on]
- glassBreak:[off|on]
Class SENSOR_MULTILEVEL
- temperature $val [C|F]
- generalPurpose $val %
- luminance $val [%|Lux]
- power $val [W|Btu/h]
- humidity $val %
- velocity $val [m/s|mph]
- direction $val
- atmosphericPressure $val [kPa|inchHg]
- barometricPressure $val [kPa|inchHg]
- solarRadiation $val W/m2
- dewpoint $val [C|F]
- rain $val [mm/h|in/h]
- tideLevel $val [m|feet]
- weight $val [kg|pound]
- voltage $val [V|mV]
- current $val [A|mA]
- CO2-level $val ppm
- airFlow $val [m3/h|cfm]
- tankCapacity $val [l|cbm|usgal]
- distance $val [m|cm|feet]
- anglePosition $val [%|relN|relS]
- rotation $val [rpm|Hz]
- waterTemperature $val [C|F]
- soilTemperature $val [C|F]
- seismicIntensity $val [mercalli|EU macroseismic|liedu|shindo]
- seismicMagnitude $val [local|moment|surface wave|body wave]
- ultraviolet $val [UV]
- electricalResistivity $val [ohm]
- electricalConductivity $val [siemens/m]
- loudness $val [dB|dBA]
- moisture $val [%|content|k ohms|water activity]
- frequency $val [Hz|kHz]
- time $val [seconds]
- targetTemperature $val [C|F]
- particulateMatter $val [mol/m3|micro-g/m3]
- formaldehydeLevel $val [mol/m3]
- radonConcentration $val [bq/m3|pCi/L]
- methaneDensity $val [mol/m3]
- volatileOrganicCompound $val [mol/m3]
- carbonMonoxide $val [mol/m3]
- soilHumidity $val [%]
- soilReactivity $val [pH]
- soilSalinity $val [mol/m3]
- heartRate $val [Bpm]
- bloodPressure $val [Systolic mmHg|Diastolic mmHg]
- muscleMass $val [Kg]
- fatMass $val [Kg]
- boneMass $val [Kg]
- totalBodyWater $val [Kg]
- basicMetabolicRate $val [J]
- bodyMassIndex $val [BMI]
Class SWITCH_ALL
- swa:[none|on|off|on off]
Class SWITCH_BINARY
- state:on
- state:off
- state:setOn
- state:setOff
Class SWITCH_MULTILEVEL
- state:on
- state:off
- state:setOn
- state:setOff
- state:dim value
- state:swmBeginUp
- state:swmBeginDown
- state:swm [Decrement|Increment] [Up|Down] Start: $sl Duration: $dur Step: $step
- state:swmEnd
Class THERMOSTAT_MODE
- off
- cooling
- heating
- manual
- setTmOff
- setTmHeating
- setTmCooling
- setTmManual
Class THERMOSTAT_SETPOINT
- setpointTemp:$temp $scale $type
  $temp: setpoint temperature with number of decimals as reported by the device
  $scale: [C|F]; C=Celsius scale, F=Fahrenheit scale
  $type: setpoint type, one of:
  heating, cooling, furnance, dryAir, moistAir, autoChangeover, energySaveHeating, energySaveCooling, awayHeating, awayCooling, fullPower
Class TIME, V2
- time:$time RTC: [failed|working]
- date:$date
- timeOffset: UTC-Offset: $utco DST-Offset(minutes): $dsto DST-Start: $start DST-End: $end
Class TIME_PARAMETERS, V1
- timeParameters: date: $date time(UTC): $time
Class USER_CODE
- userCode:id x status y code z
Class VERSION
- V1:
- version:Lib A Prot x.y App a.b
- V2:
- version:Lib A Prot x.y App a.b HW B FWCounter C FW c.d
- V1 and V2:
- versionClass_$classId:$version
Class WAKE_UP
- wakeup:notification
- wakeupReport:interval:X target:Y
- wakeupIntervalCapabilitiesReport:min W max X default Y step Z
Class ZWAVEPLUS_INFO
- zwavePlusInfo:version: V role: W node: X installerIcon: Y userIcon: Z

### alexa

Module to control the integration of Amazon Alexa devices with FHEM.
Notes:

- JSON has to be installed on the FHEM host.

Set

- reload [name]
  Reloads the device <it>name</it> or all devices in alexa-fhem. Subsequently you have to start a device discovery for the home automation skill in the amazon alexa app.

Get

- customSlotTypes
  Instructs alexa-fhem to write the device specific Custom Slot Types for the Interaction Model configuration to the alexa-fhem console and if possible to the requesting fhem frontend.
- interactionModel
  Get Intent Schema, non device specific Custom Slot Types and Sample Utterances for the Interaction Model configuration.

Attr

- alexaName
  The name to use for a device with alexa.
- alexaRoom
  The room name to use for a device with alexa.
- articles
  defaults to: der,die,das,den
- prepositions
  defaults to: in,im,in der
- alexaMapping
  maps spoken commands to intents for certain characteristics.
- alexaTypes
  maps spoken device types to ServiceClasses. eg: attr alexa alexaTypes light:licht,lampe,lampen blind:rolladen,jalousie,rollo Outlet:steckdose TemperatureSensor:thermometer LockMechanism:schloss OccupancySensor: anwesenheit
- fhemIntents
  maps spoken commands directed to fhem as a whole (i.e. not to specific devices) to events from the alexa device.
- alexaConfirmationLevel
- alexaStatusLevel
Note: changes to attributes of the alexa device will automatically trigger a reconfiguration of alxea-fhem and there is no need to restart the service.

### allergy

This modul provides allergy forecast data for Germany.
It requires the Perl module XML::Simple to be installed
Define

`define <name> allergy <zipcode>`
Example: `define allergydata allergy 12345`
- `zipcode`
  German zipcode

Get

- `data`
  Manually trigger data update

Readings

- `city`
  Name of the city the forecast is read for
- `fcn_total`
  Daily maximum levels for all allergens that are not being ignored due to ignoreList
- `fcn_day_of_week`
  Weekday, can be localized through weekdaysFormat
- `fcn_allergen`
  Daily levels for all allergens that are not being ignored due to ignoreList

Attributes

- `ignoreList`
  Comma-separated list of allergen names that are to be ignored during updates and for cumulated day levels calculation
- `updateEmpty`
  Also update (and keep) level readings for inactive allergens that are otherwise removed
- `updateIgnored`
  Also update (and keep) level readings for ignored allergens that are otherwise removed
- `levelsFormat`
  Localize levels by adding them comma separated (default: -,low,moderate,high,extreme)
- `weekdaysFormat`
  Localize Weekdays by adding them comma separated (default: Sun,Mon,Tue,Wed,Thu,Fr,Sat)

### allowed

Define

`define <name> allowed <deviceList>`
Authorize execution of commands and modification of devices based on the frontend used and/or authenticate users.
If there are multiple instances defined which are valid for a given frontend device, then all authorizations must succeed. For authentication it is sufficient when one of the instances succeeds. The checks are executed in alphabetical order of the allowed instance names.
Note: this module should work as intended, but no guarantee can be given that there is no way to circumvent it.
Examples:

`define allowedWEB allowed
attr allowedWEB validFor WEB,WEBphone,WEBtablet
attr allowedWEB basicAuth { "$user:$password" eq "admin:secret" }
attr allowedWEB allowedCommands set,get
define allowedTelnet allowed
attr allowedTelnet validFor telnetPort
attr allowedTelnet password secret
`

Set:

N/A

Get

N/A

Attributes

- disable
- allowedCommands
  A comma separated list of commands allowed from the matching frontend (see validFor).
  If set to an empty list `, (i.e. comma only)` then no comands are allowed. If set to `get,set`, then only a "regular" usage is allowed via set and get, but changing any configuration is forbidden.
- allowedDevices
  A comma separated list of device names which can be manipulated via the matching frontend (see validFor).
- basicAuth, basicAuthMsg
  request a username/password authentication for FHEMWEB access. You have to set the basicAuth attribute to the Base64 encoded value of <user>:<password>, e.g.:
  # Calculate first the encoded string with the commandline program
  $ echo -n fhemuser:secret | base64
  ZmhlbXVzZXI6c2VjcmV0
  # Set the FHEM attribute
  attr allowed_WEB basicAuth ZmhlbXVzZXI6c2VjcmV0
  You can of course use other means of base64 encoding, e.g. online Base64 encoders.
  If the argument of basicAuth is enclosed in { }, then it will be evaluated, and the $user and $password variable will be set to the values entered. If the return value is true, then the password will be accepted.
  If basicAuthMsg is set, it will be displayed in the popup window when requesting the username/password.
  Example:
  `attr allowedWEB basicAuth { "$user:$password" eq "admin:secret" }
  `
- basicAuthExpiry
  allow the basicAuth to be kept valid for a given number of days. So username/password as specified in basicAuth are only requested after a certain period. This is achieved by sending a cookie to the browser that will expire after the given period. Only valid if basicAuth is set.
- password
  Specify a password for telnet instances, which has to be entered as the very first string after the connection is established. If the argument is enclosed in {}, then it will be evaluated, and the $password variable will be set to the password entered. If the return value is true, then the password will be accepted. If this parameter is specified, FHEM sends telnet IAC requests to supress echo while entering the password. Also all returned lines are terminated with \r\n. Example:
  `attr allowed_tPort password secret
  attr allowed_tPort password {"$password" eq "secret"}`
  Note: if this attribute is set, you have to specify a password as the first argument when using fhem.pl in client mode:
  perl fhem.pl localhost:7072 secret "set lamp on"
- globalpassword
  Just like the attribute password, but a password will only required for non-local connections.
- validFor
  A comma separated list of frontend names. Currently supported frontends are all devices connected through the FHEM TCP/IP library, e.g. telnet and FHEMWEB. Note: changed behaviour:The allowed instance is only active, if this attribute is set.

### apptime

`apptime`
apptime provides information about application procedure execution time. It is designed to identify long runner jobs causing latency as well as overall high cpu usage jobs
No information about FHEM kernel times and delays will be provided.
Once started apptime monitors tasks. User may reset counter during operation. apptime adds about 1% CPU load in average to FHEM. in order to remove apptime shutdown restart is necessary.
Features:

- `apptime`
  apptime is started with the its first call nad continously monitor operation.
  To unload apptime shutdown restart is necessary
- `apptime clear`
  reset all counter and start fom Zero
- `apptime [count|funktion|average|clear|max|name|total] [all]`
  display a table sorted by the field selected
  all will display the complete table while by default only the top lines are printed.

Columns:

- name
  name of the entity executing the procedure
  if it is a function called by InternalTimer the name starts with tmr-. by then it gives the name of the funktion to be called
- function
  procedure name which was executed
  if it is an InternalTimer call it gives its calling parameter
- max
  longest duration measured for this procedure in ms
- count
  number of calls for this procedure
- total
  accumulated duration of this procedure over all calls monitored
- average
  average time a call of this procedure takes
- maxDly
  maximum delay of a timer call to its schedules time. This column is not relevant for non-timer calls.
- param Max call
  gives the parameter of the call with the max duration

### at

Start an arbitrary FHEM command at a later time.
Define

`define <name> at [<timespec>|<datespec>] <command>`
`<timespec>` format: [+][*{N}]<timedet>

The optional `+` indicates that the specification is relative(i.e. it will be added to the current time).
The optional `*` indicates that the command should be executed repeatedly.
The optional `{N}` after the * indicates,that the command should be repeated N-times only.
<timespec> is either HH:MM, HH:MM:SS or {perlfunc()}. perlfunc must return a string in timedet format. Note: {perlfunc()} may not contain any spaces or tabs.
<datespec> is either ISO8601 (YYYY-MM-DDTHH:MM:SS) or number of seconds since 1970.

Examples:

        # absolute ones:
        define a1 at 17:00:00 set lamp on                            # fhem command
        define a2 at 17:00:00 { Log 1, "Teatime" }                   # Perl command
        define a3 at 17:00:00 "/bin/echo "Teatime" > /dev/console"   # shell command
        define a4 at *17:00:00 set lamp on                           # every day

        # relative ones
        define a5 at +00:00:10 set lamp on                 # switch on in 10 seconds
        define a6 at +00:00:02 set lamp on-for-timer 1     # Blink once in 2 seconds
        define a7 at +*{3}00:00:02 set lamp on-for-timer 1 # Blink 3 times

        # Blink 3 times if the piri sends a command
        define n1 notify piri:on.* define a8 at +*{3}00:00:02 set lamp on-for-timer 1

        # Switch the lamp on from sunset to 11 PM
        define a9 at +*{sunset_rel()} set lamp on
        define a10 at *23:00:00 set lamp off

        # More elegant version, works for sunset > 23:00 too
        define a11 at +*{sunset_rel()} set lamp on-till 23:00

        # Only do this on weekend
        define a12 at +*{sunset_rel()} { fhem("set lamp on-till 23:00") if($we) }

        # Switch lamp1 and lamp2 on from 7:00 till 10 minutes after sunrise
        define a13 at *07:00 set lamp1,lamp2 on-till {sunrise(+600)}

        # Switch the lamp off 2 minutes after sunrise each day
        define a14 at *{sunrise(+120)} set lamp on

        # Switch lamp1 on at sunset, not before 18:00 and not after 21:00
        define a15 at *{sunset(0,"18:00","21:00")} set lamp1 on

Notes:

- if no `*` is specified, then a command will be executed only once, and then the `at` entry will be deleted. In this case the command will be saved to the statefile (as it considered volatile, i.e. entered by cronjob) and not to the configfile (see the save command.)
- if the current time is greater than the time specified, then the command will be executed tomorrow.
- For even more complex date handling you either have to call fhem from cron or filter the date in a perl expression, see the last example and the section Perl special.

Set

- modifyTimeSpec <timespec>
  Change the execution time. Note: the N-times repetition is ignored. It is intended to be used in combination with webCmd, for an easier modification from the room overview in FHEMWEB.
- inactive
  Inactivates the current device. Note the slight difference to the disable attribute: using set inactive the state is automatically saved to the statefile on shutdown, there is no explicit save necesary.
  This command is intended to be used by scripts to temporarily deactivate the at.
  The concurrent setting of the disable attribute is not recommended.
- active
  Activates the current device (see inactive).
- execNow
  Execute the command associated with the at. The execution of a relative at is not affected by this command.

Get

N/A

Attributes

- alignTime
  Applies only to relative at definitions: adjust the time of the next command execution so, that it will also be executed at the desired alignTime. The argument is a timespec, see above for the definition.
  Example:
  # Make sure that it chimes when the new hour begins
  define at2 at +*01:00 set Chime on-for-timer 1
  attr at2 alignTime 00:00
- computeAfterInit
  If perlfunc() in the timespec relies on some other/dummy readings, then it will return a wrong time upon FHEM start, as the at define is processed before the readings are known. If computeAfterInit is set, FHEM will recompute timespec after the initialization is finished.
- disable
  Can be applied to at/watchdog/notify/FileLog devices.
  Disables the corresponding at/notify or FileLog device. Note: If applied to an at, the command will not be executed, but the next time will be computed.
- disabledForIntervals HH:MM-HH:MM HH:MM-HH-MM...
  Space separated list of HH:MM or D@HH:MM tupels. If the current time is between the two time specifications, the current device is disabled. Instead of HH:MM you can also specify HH or HH:MM:SS. D is the day of the week, with 0 indicating Sunday and 3 indicating Wednesday. To specify an interval spawning midnight, you have to specify two intervals, e.g.:
  23:00-24:00 00:00-01:00
- skip_next
  Used for at commands: skip the execution of the command the next time.
- perlSyntaxCheck

### autocreate

Automatically create not yet defined FHEM devices upon reception of a message generated by this device. Note: devices which are polled (like the EMEM/EMWZ accessed through the EM1010PC) will NOT be automatically created.
Define

`define <name> autocreate`

By defining an instance, the global attribute autoload_undefined_devices is set, so that modules for unknnown devices are automatically loaded. The autocreate module intercepts the UNDEFINED event generated by each module, creates a device and optionally also FileLog and SVG entries.
Note 1: devices will be created with a unique name, which contains the type and a unique id for this type. When renaming the device, the automatically created filelog and SVG devices will also be renamed.
Note 2: you can disable the automatic creation by setting the disable attribute, in this case only the rename hook is active, and you can use the createlog command to add FileLog and SVG to an already defined device. Note 3: It makes no sense to create more than one instance of this module.

Example:

        define autocreate autocreate
        attr autocreate autosave
        attr autocreate device_room %TYPE
        attr autocreate filelog test2/log/%NAME-%Y.log
        attr autocreate weblink
        attr autocreate weblink_room Plots

Set

N/A

Get

N/A

Attributes

- autosave
  After creating a device, automatically save the config file with the command save command. Default is 1 (i.e. on), set it to 0 to switch it off.
  Note: this attribute is deprecated, use the global autosave attribute instead.
- device_room
  "Put" the newly created device in this room. The name can contain the wildcards %TYPE and %NAME, see the example above.
- filelog
  Create a filelog associated with the device. The filename can contain the wildcards %TYPE and %NAME, see the example above. The filelog will be "put" in the same room as the device.
- weblink
  Create an SVG associated with the device/filelog.
- weblink_room
  "Put" the newly created SVG in this room. The name can contain the wildcards %TYPE and %NAME, see the example above.
- disable
- ignoreTypes
  This is a regexp, to ignore certain devices, e.g. the neighbours FHT. You can specify more than one, with usual regexp syntax, e.g.
  attr autocreate ignoreTypes CUL_HOERMANN.*|FHT_1234|CUL_WS_7
  The word "Types" is somehow misleading, as it actually checks the generated device name.
- autocreateThreshold
  A list of <type>:<count>:<interval> triplets. A new device is only created if there have been at least `count` events of TYPE `type` in the last `interval` seconds.
  `attr autocreateThreshold LaCrosse:2:30,EMT7110:2:60`

createlog

Use this command to manually add a FileLog and an SVG to an existing device. This command is part of the autocreate module.

usb

Usage:

`usb scan
usb create
`

This command will scan the /dev directory for attached USB devices, and will try to identify them. With the argument scan you'll get back a list of FHEM commands to execute, with the argument create there will be no feedback, and the devices will be created instead.
Note that switching a CUL to HomeMatic mode is still has to be done manually.
On Linux it will also check with the lsusb command, if unflashed CULs are attached. If this is the case, it will call CULflash with the appropriate parameters (or display the CULflash command if scan is specified). The usb command will only flash one device per call.
This command is part of the autocreate module.

### average

Compute additional average, minimum and maximum values for current day and month.
Define

`define <name> average <regexp>`

The syntax for <regexp> is the same as the regexp for notify.
If it matches, and the event is of the form "eventname number", then this module computes the daily and monthly average, maximum and minimum values and sums depending on attribute settings and generates events of the form

<device> <eventname>_avg_day: <computed_average>

<device> <eventname>_min_day: <minimum day value>

<device> <eventname>_max_day: <maximum day value>

<device> <eventname>_cum_day: <sum of the values during the day>

and

<device> <eventname>_avg_month: <computed_average>

<device> <eventname>_min_month: <minimum month value>

<device> <eventname>_max_month: <maximum month value>

<device> <eventname>_cum_month: <sum of the values during the month>

at the beginning of the next day or month respectively depending on attributes defined.
The current average, minimum, maximum and the cumulated values are stored in the device readings depending on attributes defined.

Example:

        # Compute the average, minimum and maximum for the temperature events of
        # the ws1 device
        define avg_temp_ws1 average ws1:temperature.*

        # Compute the average, minimum and maximum for each temperature event
        define avg_temp_ws1 average .*:temperature.*

        # Compute the average, minimum and maximum for all temperature and humidity events
        # Events:
        # ws1 temperature: 22.3
        # ws1 humidity: 67.4
        define avg_temp_ws1 average .*:(temperature|humidity).*

        # Compute the same from a combined event. Note: we need two average
        # definitions here, each of them defining the name with the first
        # paranthesis, and the value with the second.
        #
        # Event: ws1 T: 52.3  H: 67.4
        define avg_temp_ws1_t average ws1:(T):.([-\d\.]+).*
        define avg_temp_ws1_h average ws1:.*(H):.([-\d\.]+).*

Set

N/A

Get

N/A

Attributes

- disable
- disabledForIntervals
- computeMethod
defines how values are added up for the average calculation. This attribute can be set to integral or counter. The integral mode is meant for measuring continuous values like temperature, counter is meant for adding up values, e.g. from a feeding unit. In the first case, the time between the events plays an important role, in the second case not. Default is integral.
- nominmax
don't compute min and max values. Default is 0 (compute min & max).
- noaverage
don't compute average values. Default is 0 (compute avarage).

Generated events:

- <eventname>_avg_day: $avg_day
- <eventname>_avg_month: $avg_month
- <eventname>_cum_day: $cum_day (only if cumtype is set to raw)
- <eventname>_cum_month: $cum_month (only if cumtype is set to raw)
- <eventname>_min_day: $min_day
- <eventname>_min_month: $min_month
- <eventname>_max_day: $max_day
- <eventname>_max_month: $max_month

### backup

`backup`
The complete FHEM directory (containing the modules), the WebInterface pgm2 (if installed) and the config-file will be saved into a .tar.gz file by default. The file is stored with a timestamp in the modpath/backup directory or to a directory specified by the global attribute backupdir.
Note: tar and gzip must be installed to use this feature.
If you need to call tar with support for symlinks, you could set the global attribute backupsymlink to everything else as "no".
You could pass the backup to your own command / script by using the global attribute backupcmd.

### cloneDummy

This module provides a cloneDummy which will receive readings from any other device sending data to fhem.
E.g. may be used in an FHEM2FHEM environment. Duplicate source events which may occur within the time given by the global attribute dupTimeout, will be suppressed in order to avoid overhead. The value of this attribute is to be changed with great care, as it affects other parts of FHEM, too.
the order of precedence for STATE is following:

- if there is no parameter preset then state of cloneDummy (initialized,active)
- if addStateEvent is set then the "state" of cloned Device is set (no "state" from cloneDummy)
- if the optional reading is set in define, then value of the optional reading. (this will overstrike the previous two lines)
- if stateFormat set ass attr, it will dominate all previous lines

Define

`define <cloneDevice> cloneDummy <sourceDevice> [reading]`
Example:

`define clone_OWX_26_09FF26010000 cloneDummy OWX_26_09FF26010000`

Optional parameter [reading] will be written to STATE if provided.
Example:

`define clone_OWX_26_09FF26010000 cloneDummy OWX_26_09FF26010000 temperature`

Set

N/A

Get

N/A

Attributes

- addStateEvent
  When paremeter in Modul is set to 1 the originalstate of the original Device will be STATE (Momentarily not possible in Connection with FHEM2FHEM)
- cloneIgnore
  - comma separated list of readingnames that will NOT be generated.
  Useful to prevent truncated readingnames coming from state events.
- deleteBeforeUpdate
  If set to 1, all readings will be deleted befor update.
- readingFnAttributes

Important: You MUST use different names for cloneDevice and sourceDevice!

### cmdalias

create new commands or replace internal ones.
Define

`define <name> cmdalias <cmd> [parameter] AS newcommand..."`

parameter is optional and is a regexp which must match the command entered. If it matches, then the specified newcommand will be executed, which is a fhem command (see Fhem command types for details). Like in the notify commands, $EVENT or $EVTPART may be used, in this case representing the command arguments as whole or the unique words entered.
Notes:

- newcommand may contain cmd, but recursion is not allowed.
- if there are multiple definitions, they are checked/executed in alphabetically sorted name oder.

Examples:

`define s1 cmdalias shutdown update AS save;;shutdown
define s2 cmdalias set lamp .* AS { Log 1, "$EVENT";; fhem("set $EVENT") }`

### configDB

Link to FHEM forum
This is the core backend library for configuration from SQL database.
See configdb command documentation for detailed info.

### configdb

Link to FHEM forum
Starting with version 5079, fhem can be used with a configuration database instead of a plain text file (e.g. fhem.cfg).
This offers the possibility to completely waive all cfg-files, "include"-problems and so on.
Furthermore, configDB offers a versioning of several configuration together with the possibility to restore a former configuration.
Access to database is provided via perl's database interface DBI.
Interaction with other modules

Currently the fhem modules
- 02_RSS.pm
- 55_InfoPanel.pm
- 91_eventTypes
- 93_DbLog.pm
- 95_holiday.pm
- 98_SVG.pm
will use configDB to read their configuration data from database
instead of formerly used configuration files inside the filesystem.
This requires you to import your configuration files from filesystem into database.
Example:
`configdb fileimport FHEM/nrw.holiday`
`configdb fileimport FHEM/myrss.layout`
`configdb fileimport www/gplot/xyz.gplot`
This does not affect the definitons of your holiday or RSS entities.
During migration all external configfiles used in current configuration
will be imported aufmatically.
Each fileimport into database will overwrite the file if it already exists in database.

Prerequisits / Installation

- Please install perl package Text::Diff if not already installed on your system.
- You must have access to a SQL database. Supported database types are SQLITE, MYSQL and POSTGRESQL.
- The corresponding DBD module must be available in your perl environment,
  e.g. sqlite3 running on a Debian systems requires package libdbd-sqlite3-perl
- Create an empty database, e.g. with sqlite3:

      	mba:fhem udo$ sqlite3 configDB.db

      	SQLite version 3.7.13 2012-07-17 17:46:21
      	Enter ".help" for instructions
      	Enter SQL statements terminated with a ";"
      	sqlite> pragma auto_vacuum=2;
      	sqlite> .quit

      	mba:fhem udo$

- The database tables will be created automatically.
- Create a configuration file containing the connection string to access database.
  IMPORTANT:
  - This file must be named "configDB.conf"
  - This file must be located in the same directory containing fhem.pl and configDB.pm, e.g. /opt/fhem

      ## for MySQL
      ################################################################
      #%dbconfig= (
      #	connection => "mysql:database=configDB;host=db;port=3306",
      #	user => "fhemuser",
      #	password => "fhempassword",
      #);
      ################################################################
      #
      ## for PostgreSQL
      ################################################################
      #%dbconfig= (
      #        connection => "Pg:database=configDB;host=localhost",
      #        user => "fhemuser",
      #        password => "fhempassword"
      #);
      ################################################################
      #
      ## for SQLite (username and password stay empty for SQLite)
      ################################################################
      #%dbconfig= (
      #        connection => "SQLite:dbname=/opt/fhem/configDB.db",
      #        user => "",
      #        password => ""
      #);
      ################################################################

Start with a complete new "fresh" fhem Installation

It's easy... simply start fhem by issuing following command:

`perl fhem.pl configDB`

configDB is a keyword which is recognized by fhem to use database for configuration.
That's all. Everything (save, rereadcfg etc) should work as usual.

or:
Migrate your existing fhem configuration into the database

It's easy, too...
- start your fhem the last time with fhem.cfg
  `perl fhem.pl fhem.cfg`
- transfer your existing configuration into the database
  enter
  `configdb migrate`
  into frontend's command line
  Be patient! Migration can take some time, especially on mini-systems like RaspberryPi or Beaglebone.
  Completed migration will be indicated by showing database statistics.
  Your original configfile will not be touched or modified by this step.
- shutdown fhem
- restart fhem with keyword configDB
  `perl fhem.pl configDB`
configDB is a keyword which is recognized by fhem to use database for configuration.
That's all. Everything (save, rereadcfg etc) should work as usual.

Additional functions provided

A new command `configdb` is propagated to fhem.
This command can be used with different parameters.
- `configdb attr [attribute] [value]`
Provides the possibility to pass attributes to backend and frontend.
`configdb attr private 1` - set the attribute named 'private' to value 1.
`configdb attr private` - delete the attribute named 'private'
`configdb attr` - show all defined attributes.

Supported attributes:

deleteimported if set to 1 files will always be deleted from filesystem after import to database.

maxversions set the maximum number of configurations stored in database.
The oldest version will be dropped in a "save config" if it would exceed this number.

private if set to 1 the user and password info will not be shown in 'configdb info' output.

useCache (experimental!) if set to 1 fileread from database will be cached.

- `configdb diff <device> <version>`
Compare configuration dataset for device <device> from current version 0 with version <version>
Example for valid request:
`configdb diff telnetPort 1`
will show a result like this:

    compare device: telnetPort in current version 0 (left) to version: 1 (right)
    +--+--------------------------------------+--+--------------------------------------+
    | 1|define telnetPort telnet 7072 global  | 1|define telnetPort telnet 7072 global  |
    * 2|attr telnetPort room telnet           *  |                                      |
    +--+--------------------------------------+--+--------------------------------------+

Special: configdb diff all current
Will show a diff table containing all changes between saved version 0
and UNSAVED version from memory (currently running installation).
- `configdb dump [unzipped]`
Create a gzipped dump file from from database.
If optional parameter 'unzipped' provided, dump file will be written unzipped.
- `configdb filedelete <Filename>`
Delete file from database.
- `configdb fileexport <targetFilename>|all`
Exports specified file (or all files) from database into filesystem.
Example:
`configdb fileexport FHEM/99_myUtils.pm`
- `configdb fileimport <sourceFilename>`
Imports specified text file from from filesystem into database.
Example:
`configdb fileimport FHEM/99_myUtils.pm`
- `configdb filelist`
Show a list with all filenames stored in database.
- `configdb filemove <sourceFilename>`
Imports specified fhem file from from filesystem into database and
deletes the file from local filesystem afterwards.
Example:
`configdb filemove FHEM/99_myUtils.pm`
- `configdb fileshow <Filename>`
Show content of specified file stored in database.
- `configdb info`
Returns some database statistics

    --------------------------------------------------------------------------------
     configDB Database Information
    --------------------------------------------------------------------------------
     dbconn: SQLite:dbname=/opt/fhem/configDB.db
     dbuser:
     dbpass:
     dbtype: SQLITE
    --------------------------------------------------------------------------------
     fhemconfig: 7707 entries

     Ver 0 saved: Sat Mar  1 11:37:00 2014 def: 293 attr: 1248
     Ver 1 saved: Fri Feb 28 23:55:13 2014 def: 293 attr: 1248
     Ver 2 saved: Fri Feb 28 23:49:01 2014 def: 293 attr: 1248
     Ver 3 saved: Fri Feb 28 22:24:40 2014 def: 293 attr: 1247
     Ver 4 saved: Fri Feb 28 22:14:03 2014 def: 293 attr: 1246
    --------------------------------------------------------------------------------
     fhemstate: 1890 entries saved: Sat Mar  1 12:05:00 2014
    --------------------------------------------------------------------------------

Ver 0 always indicates the currently running configuration.
- `configdb list [device] [version]`
Search for device named [device] in configuration version [version]
in database archive.
Default value for [device] = % to show all devices.
Default value for [version] = 0 to show devices from current version.
Examples for valid requests:
`get configDB list`
`get configDB list global`
`get configDB list '' 1`
`get configDB list global 1`
- `configdb recover <version>`
Restores an older version from database archive.
`configdb recover 3` will copy version #3 from database to version #0.
Original version #0 will be lost.
Important!
The restored version will NOT be activated automatically!
You must do a `rereadcfg` or - even better - `shutdown restart` yourself.
- `configdb reorg [keep]`
Deletes all stored versions with version number higher than [keep].
Default value for optional parameter keep = 3.
This function can be used to create a nightly running job for
database reorganisation when called from an at-Definition.
- `configdb search <searchTerm> [searchVersion]`
Search for specified searchTerm in any given version (default=0)

    Example:

    configdb search %2286BC%

    Result:

    search result for: %2286BC% in version: 0
    --------------------------------------------------------------------------------
    define az_RT CUL_HM 2286BC
    define az_RT_Clima CUL_HM 2286BC04
    define az_RT_Climate CUL_HM 2286BC02
    define az_RT_ClimaTeam CUL_HM 2286BC05
    define az_RT_remote CUL_HM 2286BC06
    define az_RT_Weather CUL_HM 2286BC01
    define az_RT_WindowRec CUL_HM 2286BC03
    attr Melder_FAl peerIDs 00000000,2286BC03,
    attr Melder_FAr peerIDs 00000000,2286BC03,

- `configdb uuid`
Returns a uuid that can be used for own purposes.

Author's notes

- You can find two template files for datebase and configfile (sqlite only!) for easy installation.
  Just copy them to your fhem installation directory (/opt/fhem) and have fun.
- The frontend option "Edit files"->"config file" will be removed when running configDB.
- Please be patient when issuing a "save" command (either manually or by clicking on "save config").
  This will take some moments, due to writing version informations.
  Finishing the save-process will be indicated by a corresponding message in frontend.
- There still will be some more (planned) development to this extension, especially regarding some perfomance issues.
- Have fun!

### copy

`copy <orig name> <copy name> [<type dependent arguments>]`
Create a copy of device <orig name> with the name <copy name>.
If <type dependent arguments> are given they will replace the DEF of <orig name> for the creation of <copy name>.

### count

`count [devspec]`
Count devices specified by devspec.
If no devspec given, count will return number of totally defined devices.

### dash_dhcp

Module to integrate amazon dash buttons into FHEM;.
The module can listen direclty to dhcp broadcast messages or listen to redirected openwrt dhcp log messages. Notes:

- if listening for dhcp messages the module has to run as root or you have to redirect port 67 with
  `iptables -A PREROUTING -t nat -i eth0 -p udp --dport 67 -j REDIRECT --to-port 6767`
  or
  `iptables -I PREROUTING -t nat -i eth0 -p udp --src 0.0.0.0 --dport 67 -j DNAT --to 0.0.0.0:6767`
  and use the port attribute to configure the redirected port.
- to make iptables rules permanent see for example: https://www.thomas-krenn.com/de/wiki/Iptables_Firewall_Regeln_dauerhaft_speichern

Attr

- devAlias
  space separated list of <mac>:<alias> pairs.
- allowed
  comma separated list of allowed mac adresses
- port
  the listen port. defaults to 67 for root and 6767 for other users.
- disable
- disabledForIntervals

### deletefile

`deletefile <filename>`
Delete a file in filesystem.
- File must be listed in "Edit files"
- File fhem.cfg must not be deleted.
- Wildcards are not evaluated.

### dewpoint

Dewpoint calculations. Offers three different ways to use dewpoint:

- dewpoint
  Compute additional event dewpoint from a sensor offering temperature and humidity.
- fan
  Generate a event to turn a fan on if the outside air has less water than the inside.
- alarm
  Generate a mold alarm if a reference temperature is lower that the current dewpoint.

Define

`define <name> dewpoint dewpoint <devicename-regex> [<temp_name> <hum_name> <new_name>]`

Calculates dewpoint for device <devicename-regex> from temperature and humidity and write it to a new reading named dewpoint. If optional <temp_name>, <hum_name> and <new_name> is specified then read temperature from reading <temp_name>, humidity from reading <hum_name> and write the calculated dewpoint to reading <new_name>.
If <temp_name> is T then use temperature from state T: H:, add <new_name> to the state.

Example:

        # Compute the dewpoint for the temperature/humidity
        # events of the temp1 device and generate reading dewpoint.
        define dew_temp1 dewpoint dewpoint temp1
        define dew_temp1 dewpoint dewpoint temp1 temperature humidity dewpoint

        # Compute the dewpoint for the temperature/humidity
        # events of all devices offering temperature and humidity
        # and generate reading dewpoint.
        define dew_all dewpoint dewpoint .*
        define dew_all dewpoint dewpoint .* temperature humidity dewpoint

        # Compute the dewpoint for the temperature/humidity
        # events of the device Aussen_1 offering temperature and humidity
        # and insert is into STATE.
        define dew_state dewpoint dewpoint Aussen_1 T H D

        # Compute the dewpoint for the temperature/humidity
        # events of all devices offering temperature and humidity
        # and insert the result into the STATE.
        # Example STATE: "T: 10 H: 62.5" will change to
        # "T: 10 H: 62.5 D: 3.2"
        define dew_state dewpoint dewpoint .* T H D

`define <name> dewpoint fan <devicename-regex> <devicename-outside> <min-temp> [<diff_temp>]`

May be used to turn an fan on or off if the outside air has less water.

- Generate event "fan: on" if (dewpoint of <devicename-outside>) + <diff_temp> is lower than dewpoint of <devicename> and temperature of <devicename-outside> is >= min-temp and reading "fan" was not already "on". The event will be generated for <devicename>. Parameter <diff-temp> is optional
- Generate event "fan: off": else and if reading "fan" was not already "off".

Example:

        # Generate event "fan: on" when dewpoint of Aussen_1 is first
        # time lower than basement_tempsensor and outside temperature is >= 0
        # and change it to "fan: off" is this condition changes.
        # Set a switch on/off (fan_switch) depending on the state.
        define dew_fan1 dewpoint fan basement_tempsensor Aussen_1 0
        define dew_fan1_on notify basement_tempsensor.*fan:.*on set fan_switch on
        define dew_fan1_off notify basement_tempsensor.*fan:.*off set fan_switch off

`define <name> dewpoint alarm <devicename-regex> <devicename-reference> <diff-temp>`

Generate a mold alarm if a reference temperature is lower that the current dewpoint.

- Generate reading/event "alarm: on" if temperature of <devicename-reference> - <diff-temp> is lower than dewpoint of <devicename> and reading "alarm" was not already "on". The event will be generated for <devicename>.
- Generate reading/event "alarm: off" if temperature of <devicename-reference> - <diff-temp> is higher than dewpoint of <devicename> and reading "alarm" was not already "off".

Example:

        # Using a wall temperature sensor (wallsensor) and a temp/hum sensor
        # (roomsensor) to alarm if the temperature of the wall is lower than
        # the dewpoint of the air. In this case the water of the air will
        # condense on the wall because the wall is cold.
        # Set a switch on (alarm_siren) if alarm is on using notify.
        define dew_alarm1 dewpoint alarm roomsensor wallsensor 0
        define roomsensor_alarm_on notify roomsensor.*alarm:.*on set alarm_siren on
        define roomsensor_alarm_off notify roomsensor.*alarm:.*off set alarm_siren off

        # If you do not have a temperature sensor in/on the wall, you may also
        # compare the rooms dewpoint to the temperature of the same or another
        # inside sensor. Alarm is temperature is 5 degrees colder than the
        # inside dewpointinside.
        define dev_alarm2 dewpoint alarm roomsensor roomsensor 5

Set

N/A

Get

N/A

Attributes

- disable
- absFeuchte

AbsFeuchte also becomes by the absolute humidity set the attribute into the Readings of all things. One can by these show information also in the status. Example: (<Adapter> = the FHEM name of the adapter this one you must change)

    		 stateFormat:
    		{sprintf("T: %.1f H: %.1f D: %.1f A: %.1f", ReadingsVal("<Adapter>","temperature",0), ReadingsVal("<Adapter>","H",0), ReadingsVal("<Adapter>","dewpoint",0), ReadingsVal("<Adapter>","absFeuchte",0))}

- max_timediff
  Maximum time difference in seconds allowed between the temperature and humidity values for a device. dewpoint uses the Readings for temperature or humidity if they are not delivered in the event. This is necessary for using dewpoint with event-on-change-reading. Also needed for sensors that do deliver temperature and humidity in different events like for example technoline sensors TX3TH.
  If not set default is 1 second.
  Examples:

      		# allow maximum time difference of 60 seconds
      		define dew_all dewpoint dewpoint .*
      		attr dew_all max_timediff 60

### dummy

Define a dummy. A dummy can take via set any values. Used for programming.
Define

`define <name> dummy`
Example:

`define myvar dummy`
`set myvar 7`

Set

`set <name> <value>`
Set any value.

Get

N/A

Attributes

- disable
- disabledForIntervals
- readingList
  Space separated list of readings, which will be set, if the first argument of the set command matches one of them.
- setList
  Space separated list of commands, which will be returned upon "set name ?", so the FHEMWEB frontend can construct a dropdown and offer on/off switches. Example: attr dummyName setList on off
- useSetExtensions
  If set, and setList contains on and off, then the set extensions are supported. In this case no arbitrary set commands are accepted, only the setList and the set exensions commands.
- readingFnAttributes

### eventTypes

Define

`define <name> eventTypes <filename>`
Collect event types for all devices. This service is used by frontends, e.g. notify and FileLog, to assist you in selecting the correct events. The filename is used to store the collected events before shutdown.
More than one instance of eventTypes should not be necessary. Examples:

`define et eventTypes log/eventTypes.txt`

Set

- flush
  used to write all collected event types into datafile.
- clear
  used to clear the internal table containing all collected event types.

Get

- list [devicename]
  return the list of collected event types for all devices or for devicename if specified.

Attributes

- disable
- ignoreList
  Comma separated device names to ignore whe collecting the events. E.g. ECMD-Devices are used to post RAW data as events.

### fakeRoku

This module allows you to add a 'fake' roku player device to a harmony hub based remote and to receive and process configured key presses in FHEM.
Notes:

- XML::Simple is needed.
- IO::Socket::Multicast is needed.
- The following 12 functions are available and can be used:
  - InstantReplay
  - Home
  - Info
  - Search
  - Back
  - FastForward = Fwd
  - Rewind = Rev
  - Select
  - DirectionUp
  - DirectionRight
  - DirectionLeft
  - DirectionDown

Define

`define <name> fakeRoku`

Set

none

Get

none

Attr

- favourites
  comma separated list of names to use as apps/channels/favourites. the list can be reloaded on the harmony with edit->reset.
- fhemIP
  overwrites autodetected local ip used in advertising
- httpPort
- reusePort
  not set -> set ReusePort on multicast socket if SO_REUSEPORT flag ist known. should work in most cases.
0 -> don't set ReusePort on multicast socket
1 -> set ReusePort on multicast socket

### fhemdebug

`fhemdebug {enable|disable|status}`
fhemdebug produces debug information in the FHEM Log to help localize certain error messages. Currently following errors are examined:

- Error: >...< has no TYPE, but following keys: >...<

As it frequently examines internal data-structures, it uses a lot of CPU, it is not recommended to enable it all the time. A FHEM restart after disabling it is not necessary.

### fheminfo

`fheminfo [send]`
fheminfo displays information about the system and FHEM definitions.
The optional parameter `send` transmitts the collected data to a central server in order to support the development of FHEM. The transmitted data is processed graphically. The results can be viewed on http://fhem.de/stats/statistics.html. Based on the IP address, the approximate location is determined with an accuracy of about 40-80 km. The IP address is not saved.
Features:

- Operating System Information
- Hardware architecture
- Installed Perl version
- Installed FHEM release
- Defined modules (only official FHEM Modules are counted)
- Defined models per module

Example:

          fhem> fheminfo
          Fhem info:
            Release  : 5.3
            OS       : linux
            Arch     : i686-linux-gnu-thread-multi-64int
            Perl     : v5.14.2
            uniqueID : 87c5cca38dc75a4f388ef87bdcbfbf6f

          Defined modules:
            ACU        : 1
            CUL        : 1
            CUL_FHTTK  : 12
            CUL_HM     : 66
            CUL_WS     : 3
            FHEM2FHEM  : 1
            FHEMWEB    : 3
            FHT        : 9
          [...]
            at         : 4
            autocreate : 1
            dummy      : 23
            notify     : 54
            structure  : 3
            telnet     : 2
            watchdog   : 9
            weblink    : 17

          Defined models per module:
            CUL        : CUN
            CUL_FHTTK  : FHT80TF
            CUL_HM     : HM-CC-TC,HM-CC-VD,HM-LC-DIM1T-CV,HM-LC-DIM1T-FM,HM-LC-SW1-PL,[...]
            CUL_WS     : S555TH
            FHT        : fht80b
            FS20       : fs20pira,fs20s16,fs20s4a,fs20sd,fs20st
            HMS        : hms100-mg,hms100-tf,hms100-wd
            KS300      : ks300
            OWSWITCH   : DS2413

Attributes
The following attributes are used only in conjunction with the `send` parameter. They are set on `attr global`.

- sendStatistics
  This attribute is used in conjunction with the `update` command.
  `onUpdate`: transfer of data on every update (recommended setting).
  `manually`: manually transfer of data via the `fheminfo send` command.
  `never`: prevents transmission of data at anytime.

### harmony

Defines a device to integrate a Logitech Harmony Hub based remote control into fhem.
It is possible to: start and stop activities, send ir commands to devices, send keyboard input by bluetooth and smart keyboard usb dongles.
You probably want to use it in conjunction with the fakeRoku module.
Notes:

- JSON has to be installed on the FHEM host.
- For hubs with firmware version 3.x.y <username> and <password> are not required as no authentication with the logitech myharmony server is needed for the full functionality of this module.
- For hubs with firmware version 4.x.y <username> and <password> are required for device level control. Activit level control is (currently) still possible without authentication.
- activity and device names can be given as id or name. names can be given as a regex and spaces in names musst be replaced by a single '.' (dot).

Define

`define <name> harmony [<username> <password>] <ip>`
Defines a harmony device.
Examples:

`define hub harmony 10.0.1.4`

Readings

- currentActivity
  the name of the currently selected activity.
- previousActivity
  the name of the previous selected activity. does not trigger an event.
- newVersion
  will be set if a new firmware version is avaliable.

Internals

- currentActivityID
  the id of the currently selected activity.
- previousActivityID
  the id of the previous selected activity.
- sleeptimer
  timeout for sleeptimer if any is set.

Set

- activity <id>|<name> [<channel>]
  switch to this activit and optionally switch to <channel>
- channel <channel>
  switch to <channel> in the current activity
- command [<id>|<name>] <command>
  send the given ir command for the current activity or for the given device
- getConfig
  request the configuration from the hub
- getCurrentActivity
  request the current activity from the hub
- off
  switch current activity off
- reconnect [all]
  close connection to the hub and reconnect, if `all` is given also reconnect to the logitech server
- sleeptimer [<timeout>]
  <timeout> -> timeout in minutes
  -1 -> timer off
  default -> 60 minutes
- sync
  syncs the hub to the myHarmony config
- hidDevice [<id>|<name>]
  sets the target device for keyboard commands, if no device is given -> set the target to the default device for the current activity.
- text <text>
  sends <text> by bluetooth/smart keaboard dongle. a-z ,A-Z ,0-9, \n, \e, \t and space are currently possible
- cursor <direction>
  moves the cursor by bluetooth/smart keaboard dongle. <direction> can be one of: up, down, left, right, pageUp, pageDown, home, end.
- special <key>
  sends special key by bluetooth/smart keaboard dongle. <key> can be one of: previousTrack, nextTrack, stop, playPause, volumeUp, volumeDown, mute.
- autocreate [<id>|<name>]
  creates a fhem device for a single/all device(s) in the harmony hub. if activities are startet the state of these devices will be updatet with the power state defined in these activites.
- update
  triggers a firmware update. only available if a new firmware is available.

The command, hidDevice, text, cursor and special commmands are also available for the autocreated devices. The <id>|<name> paramter hast to be omitted.
Get

- activites [<param>]
  lists all activities
  parm = power -> list power state for each device in activity
- devices [<param>]
  lists all devices
- commands [<id>|<name>]
  lists the commands for the specified activity or for all activities
- deviceCommands [<id>|<name>]
  lists the commands for the specified device or for all devices
- activityDetail [<id>|<name>]
- deviceDetail [<id>|<name>]
- configDetail
- currentActivity
  returns the current activity name
- showAccount
  display obfuscated user and password in cleartext

The commands commmand is also available for the autocreated devices. The <id>|<name> paramter hast to be omitted.
Attributes

- disable
  1 -> disconnect from the hub

### ?, help

`? [<moduleName|deviceName>] [<language>]`
`help [<moduleName|deviceName>] [<language>]`

- Returns a list of available commands, when called without a moduleName/deviceName.
- Returns a module dependent helptext, same as in commandref.
- language will be determined in following order:
  - valid parameter <language> given
  - global attribute language
  - nothing founde: return english

### holiday

Define

`define <name> holiday`
Define a set of holidays. The module will try to open the file <name>.holiday in the modpath/FHEM directory. If entries in the holiday file match the current day, then the STATE of this holiday instance displayed in the list command will be set to the corresponding values, else the state is set to the text none. Most probably you'll want to query this value in some perl script: see Value() in the perl section or the global attribute holiday2we.
The file will be reread once every night, to compute the value for the current day, and by each get command (see below).
Holiday file definition:
The file may contain comments (beginning with #) or empty lines. Significant lines begin with a number (type) and contain some space separated words, depending on the type. The different types are:

- 1
  Exact date. Arguments: <MM-DD> <holiday-name>
  Exampe: 1 12-24 Christmas
- 2
  Easter-dependent date. Arguments: <day-offset> <holiday-name>. The offset is counted from Easter-Sunday.
  Exampe: 2 1 Easter-Monday
  Sidenote: You can check the easter date with: fhem> { join("-", western_easter(2011)) }
- 3
  Month dependent date. Arguments: <nth> <weekday> <month <holiday-name>.
  Examples:
  3 1 Mon 05 First Monday In May
  3 2 Mon 05 Second Monday In May
  3 -1 Mon 05 Last Monday In May
  3 0 Mon 05 Each Monday In May
- 4
  Interval. Arguments: <MM-DD> <MM-DD> <holiday-name> .
  Note: An interval cannot contain the year-end. Example:
  4 06-01 06-30 Summer holiday
  4 12-20 01-10 Winter holiday # DOES NOT WORK. Use the following 2 lines instead:
  4 12-20 12-31 Winter holiday
  4 01-01 01-10 Winter holiday
- 5
  Date relative, weekday fixed holiday. Arguments: <nth> <weekday> <month> <day> < holiday-name>
  Note that while +0 or -0 as offsets are not forbidden, their behaviour is undefined in the sense that it might change without notice.
  Examples:
  5 -1 Wed 11 23 Buss und Bettag (first Wednesday before Nov, 23rd)
  5 1 Mon 01 31 First Monday after Jan, 31st (1st Monday in February)

See also he.holiday in the contrib directory for official holidays in the german country of Hessen, and by.holiday for the Bavarian definition.

Set

N/A

Get

`get <name> <MM-DD>`
`get <name> yesterday`
`get <name> today`
`get <name> tomorrow`
`get <name> days <offset>`
Return the holiday name of the specified date or the text none.

Attributes

N/A

### KM200

The Buderus KM200, KM100 or KM50 (hereafter described as KMxxx) is a communication device to establish a connection between the Buderus central heating control unit and the internet.
It has been designed in order to allow the inhabitants accessing their heating system via his Buderus App EasyControl.
Furthermore it allows the maintenance companies to access the central heating control system to read and change settings.
The km200 fhem-module enables read/write access to these parameters.
In order to use the KMxxx with fhem, you must define the private password with the Buderus App EasyControl first.
Remark:
Despite the instruction of the Buderus KMxxx Installation guide, the ports 5222 and 5223 should not be opened and allow access to the KMxxx module from outside.
You should configure (or leave) your internet router with the respective settings.
If you want to read or change settings on the heating system, you should access the central heating control system via your fhem system only.
As soon the module has been defined within the fhem.cfg, the module is trying to obtain all known/possible services.
After this initial contact, the module differs between a set of continuous (dynamically) changing values (e.g.: temperatures) and not changing static values (e.g.: Firmware version).
This two different set of values can be bound to an individual polling interval. Refer to Attributes

Define

`define <name> km200 <IPv4-address> <GatewayPassword> <PrivatePassword>`

`<name>` : | The name of the device. Recommendation: "myKm200".
`<IPv4-address>` : | A valid IPv4 address of the KMxxx. You might look into your router which DHCP address has been given to the KMxxx.
`<GatewayPassword>` : | The gateway password which is provided on the type sign of the KMxxx.
`<PrivatePassword>` : | The private password which has been defined by the user via EasyControl.

Set

The set function is able to change a value of a service which has the "writeable" - tag within the KMxxx service structure.
Most of those values have an additional list of allowed values which are the only ones to be set.
Other floatable type values can be changed only within their range of minimum and maximum value.

`set <service> <value>`

`<service>` : | The name of the service which value shall be set. E.g.: "`/heatingCircuits/hc1/operationMode`"
`<value>` : | A valid value for this service.

Get

The get function is able to obtain a value of a service within the KMxxx service structure.
The additional list of allowed values or their range of minimum and maximum value will not be handed back.

`get <service> <option>`

`<service>` : | The name of the service which value shall be obtained. E.g.: "`/heatingCircuits/hc1/operationMode`" It returns only the value but not the unit or the range or list of allowed values possible.

`<option>` : | The optional Argument for the result of the get-command e.g.: "`json`" The following options are available: json - Returns the raw json-answer from the KMxxx as string.

Attributes

The following user attributes can be used with the km200 module in addition to the global ones e.g. room.

- `IntervalDynVal` :

A valid polling interval for the dynamically changing values of the KMxxx. The value must be >=20s to allow the km200 module to perform a full polling procedure.
The default value is 300s.

- `PollingTimeout` :

A valid time in order to allow the module to wait for a response of the KMxxx. Usually this value does not need to be changed but might in case of slow network or slow response.
The default and minimum value is 5s.

- `DoNotPoll` :

A list of services separated by blanks which shall not be downloaded due to repeatable crashes or irrelevant values.
The list can be filled with the name of the top - hierarchy service, which means everything below that service will also be ignored.
The default value (empty) therefore nothing will be ignored.

- `ReadBackDelay` :

A valid time in milliseconds [ms] for the delay between writing and re-reading of values after using the "set" - command. The value must be >=0ms.
The default value is 100 = 100ms = 0,1s.

- `disable` :

Stops the device from further pollings and deletes the existing readings.
The default value is 0 = activated

### logProxy

Allows the manipulation of data to be plotted in an SVG device:

- addition of horizontal lines at fixed values
- addition of horizontal lines at dynamic values eg: min, max or average values of another plot
- addition of vertical lines at fixed or dynamic times between two fixed or dynamic y values
- addition of calculated data like week profiles of HeatingControll devices or heating thermostats
- merge plot data from different sources. eg. different FileLog devices
- horizontaly shifting a (merged) plot to align average or statistic data to the correct day,week and month

Define

`define <name> logProxy`
Only one logProxy device can be defined and is needed.
Example:

`define myProxy logProxy`

Set

Get

see FileLog and DbLog

Attributes

#logProxy <column_spec>
where <column_spec> can be one or more of the following:

- FileLog:<log device>[,<options>]:<column_spec>
- DbLog:<log device>[,<options>]:<column_spec>
options is a comma separated list of zero or more of:

- clip
  clip the plot data to the plot window
- extend=<value>
  extend the query range to the log device by <value> seconds (or <value> months if <value> ends in m). also activates cliping.
- interpolate
  perform a linear interpolation to the values in the extended range to get the values at the plot boundary. only usefull if plotfunction is lines.
- offset=<value>
  shift plot by <value> seconds (or <value> months if <value> ends in m). allows alignment of values calculated by average or statsitics module to the correct day, week or month.
- predict[=<value>]
  no value -> extend the last plot value to now.
  value -> extend the last plot value by <value> but maximal to now.
- postFn='<myPostFn>'
  myPostFn is the name of a postprocessing function that is called after all processing of the data by logProxy has been done. it is called with two arguments: the devspec line from the gplot file and a reference to a data array containing the points of the plot. each point is an array with three components: the point in time in seconds, the value at this point and the point in time in string form. the return value must return a reference to an array of the same format. the third component of each point can be omittet and is not evaluated.
- scale2reading=<scaleHashRef>
  Use zoom step dependent reading names.
  The reading name to be used is the result of a lookup with the current zoom step into `scaleHashRef`. The keys can be from the following list: year, month, week, day, qday, hour
  Example:
  `#logProxy DbLog:dbLog,scale2reading={year=>'temperature_avg_day',month=>'temperature_avg_day'}:s300ht_1:temperature::`

- ConstX:<time>,<y>[,<y2>]
  Will draw a vertical line (or point) at <time> between <y> to <y2>.
  Everything after the : is evaluated as a perl expression that hast to return one time string and one or two y values.
  Examples:
  `#logProxy ConstX:$data{currdate1},$data{currval1}`
  `#logProxy ConstX:$data{mindate1},$data{min1},$data{avg1}`
  `#logProxy ConstX:$data{maxdate1},$data{max1},$data{avg1}`
  `#logProxy ConstX:logProxy_shiftTime($from,60*60*2),$data{min1},$data{max1}`
- ConstY:<value>[,<from>[,<to>]]
  Will draw a horizontal line at <value>, optional only between the from and to times.
  Everything after the : is evaluated as a perl expression that hast to return one value and optionaly one or two time strings.
  Examples:
  `#logProxy ConstY:0`
  `#logProxy ConstY:1234+15+myFunc(123)`
  `#logProxy ConstY:$data{avg1}`
  `#logProxy ConstY:$data{avg2},$from,$to`
  `#logProxy ConstY:$data{avg2},logProxy_shiftTime($from,60*60*12),logProxy_shiftTime($from,-60*60*12)`
- Polar:[<options>]:<values>
  Will draw a polar/spiderweb diagram with the given values. <values> has to evaluate to a perl array.
  If <values> contains numbers these values are plottet and the last value will be connected to the first.
  If <values> contains strings these strings are used as labels for the segments.
  The axis are drawn automaticaly if the values are strings or if no values are given but the segments option is set.
  The corrosponding SVG device should have the plotsize attribute set (eg: attr <mySvg> plotsize 340,300) and the used gplot file has to contain xrange and yrange entries and the x- and y-axis labes should be switched off with xtics, ytics and y2tics entries.
  The following example will plot the temperature and desiredTemperature values of all devices named MAX.*:
  `set xtics ()`
  `set ytics ()`
  `set y2tics ()`
  `set xrange [-40:40]`
  `set yrange [-40:40]`
  `#logProxy Polar::{[map{ReadingsVal($_,"temperature",0)}devspec2array("MAX.*")]}`
  `#logProxy Polar::{[map{ReadingsVal($_,"desiredTemperature",0)}devspec2array("MAX.*")]}`
  `#logProxy Polar::{[map{ReadingsVal($_,"temperature",0)}devspec2array("MAX.*")]}`
  `#logProxy Polar::{[devspec2array("MAX.*")]}`
  `plot "<IN>" using 1:2 axes x1y1 title 'Ist' ls l0 lw 1 with lines,\`
  `plot "<IN>" using 1:2 axes x1y1 title 'Soll' ls l1fill lw 1 with lines,\`
  `plot "<IN>" using 1:2 axes x1y1 notitle ls l0 lw 1 with points,\`
  `plot "<IN>" using 1:2 axes x1y1 notitle ls l2 lw 1 with lines,\`
  options is a comma separated list of zero or more of:
  - axis
    force to draw the axis
  - noaxis
    disable to draw the axis
  - range=<value>
    the range to use for the radial axis
  - segments=<value>
    the number of circle/spiderweb segments to use for the plot
  - isolines=<value>
    a | separated list of values for which an isoline shoud be drawn. defaults to 10|20|30.
- Func:<perl expression>
  Specifies a perl expression that returns the data to be plotted and its min, max and last value. It can not contain space or : characters. The data has to be one string of newline separated entries of the form: `yyyy-mm-dd_hh:mm:ss value`
  Example:
  `#logProxy Func:logProxy_WeekProfile2Plot("HCB",$from,$to)`
  `#logProxy Func:logProxy_WeekProfile2Plot("myHeatingControll",$from,$to,"(\\d)*\$")`
  `#logProxy Func:logProxy_Func2Plot($from,$to,'{logProxy_hms2dec(sunrise_abs_dat($sec))}')`
  `#logProxy Func:logProxy_Func2Plot($from,$to,'{logProxy_hms2dec(sunset_abs_dat($sec))}')`
  Notes:
  - logProxy_WeekProfile2Plot is a sample implementation of a function that will plot the week profile of a Heating_Control, WeekdyTimer, HomeMatic or MAX Thermostat device can be found in the 98_logProxy.pm module file.
  - logProxy_Func2Plot($from,$to,$func) is a sample implementation of a function that will evaluate the given function (3rd parameter) for a zoom factor dependent number of times. the current time is given in $sec. the step width can be given in an optional 4th parameter. either as a number or as an hash with the keys from the following list: hour,qday,day,week,month,year and the values representing the step with for the zoom level.
  - logProxy_xy2Plot(\@xyArray) is a sample implementation of a function that will accept a ref to an array of xy-cordinate pairs as the data to be plotted.
  - logProxy_xyFile2Plot($filename,$column,$regex) is a sample implementation of a function that will accept a filename, a column number and a regular expression. The requested column in all lines in the file that match the regular expression needs to be in the format x,y to indicate the xy-cordinate pairs as the data to be plotted.
  - logProxy_values2Plot(\@xyArray) is a sample implementation of a function that will accept a ref to an array of date-y-cordinate pairs as the data to be plotted.
  - The perl expressions have access to $from and $to for the begining and end of the plot range and also to the SVG specials min, max, avg, cnt, sum, currval (last value) and currdate (last date) values of the individual curves already plotted are available as $data{<special-n>}.
  - logProxy_Range2Zoom($seconds) can be used to get the approximate zoom step for a plot range of $seconds.
  - SVG_time_to_sec($timestamp) can be used to convert the timestamp strings to epoch times for calculation.

Please see also the column_spec paragraphs of FileLog, DbLog and SVG.
NOTE: spaces are not allowed inside the colums_specs.
To use any of the logProxy features with an existing plot the associated SVG file hast to be changed to use the logProxy device and the .gplot file has to be changed in the following way:
All existing #FileLog and #Dblog lines have to be changed to #logProxy lines and
the column_spec of these line has to be prepended by `FileLog:<log device>:` or `DbLog:<log device>:` respectively.
Examples:

`#DbLog <myDevice>:<myReading>` `#FileLog 4:<SPEC1>:power\x3a::`
`#FileLog 4:<SPEC1>:consumption\x3a::`
will become:
`#logProxy DbLog:<myDb>:<myDevice>:<myReading>` `#logProxy FileLog:FileLog_<SPEC1>:4:<SPEC1>.power\x3a::`
`#logProxy FileLog:FileLog_<SPEC1>:4:<SPEC1>.consumption\x3a::`

### mailcheck

Watches a mailbox with imap idle and for each new mail triggers an event with the subject of this mail.
This can be used to send mails *to* FHEM and react to them from a notify. Application scenarios are for example a geofencing apps on mobile phones, networked devices that inform about warning or failure conditions by e-mail or (with a little logic in FHEM) the absence of regular status messages from such devices and so on.
Notes:

- Mail::IMAPClient and IO::Socket::SSL and IO::Socket::INET hast to be installed on the FHEM host.
- Probably only works reliably if no other mail programm is marking messages as read at the same time.
- If you experience a hanging system caused by regular forced disconnects of your internet provider you can disable and enable the mailcheck instance with an at.
- If MIME::Parser is installed non ascii subjects will be docoded to utf-8
- If MIME::Parser and Mail::GnuPG are installed gpg signatures can be checked and mails from unknown senders can be ignored.

Define

`define <name> mailcheck <host> <user> <password> [<folder>]`
<user> and <lt><password> can be of the form {perl-code}. no spaces are allowed. for both evals $NAME and $HOST is set to the name and host of the mailcheck device and $USER is set to the user in the password eval.
Defines a mailcheck device.
Examples:

`define mailcheck mailcheck imap.mail.me.com x.y@me.com myPassword`
`define mailcheck mailcheck imap.mail.me.com {"x.y@me.com"} {myPasswordOfAccount($USER)}`

Readings

- Subject
  the subject of the last mail received
- From
  the mail address of the last sender

Set

- inactive
  temporarily deactivates the device
- active
  reenables the device

Get

- update
  trigger an update
- folders
  list available folders

Attributes

- delete_message
  1 -> delete message after Subject reading is created
- interval
  the interval in seconds used to trigger an update on the connection. if idle is supported the defailt is 600, without idle support the default is 60. the minimum is 60.
- nossl
  1 -> don't use ssl.
- disable
  1 -> disconnect and stop polling
- debug
  1 -> enables debug output. default target is stdout.
- logfile
  set the target for debug messages if debug is enabled.
- accept_from
  comma separated list of gpg keys that will be accepted for signed messages. Mail::GnuPG and MIME::Parser have to be installed

### msgConfig

Provides global settings and tools for FHEM command msg.
A device named globalMsg will be created automatically when using msg-command for the first time and no msgConfig device could be found.
The device name can be renamed and reconfigured afterwards if desired.
Define

`define <name> msgConfig`

Set

- addLocation <Location Name>
  Conveniently creates a Dummy device based on the given location name. It will be pre-configured to be used together with location-based routing when using the msg-command. The dummy device will be added to attribute msgLocationDevs automatically. Afterwards additional configuration is required by adding msgContact* or msgRecipient* attributes for gateway devices placed at this specific location.
- cleanReadings [<device and/or regex>]
  Easy way to cleanup all fhemMsg readings. A parameter is optional and can be a concrete device name or mixed together with regex. This command is an alias for "deletereading <device and/or regex> fhemMsg.*".
- createResidentsDev <de|en>
  Creates a new device named rgr_Residents of type RESIDENTS. It will be pre-configured based on the given language. In case rgr_Residents exists it will be updated based on the given language (basically only a language change). Afterwards next configuration steps will be displayed to use RESIDENTS together with presence-based routing of the msg-command.
  This next step is basically to set attribute msgResidentsDevice to refer to this RESIDENTS device either globally or for any other specific FHEM device (most likely you do NOT want to have this attribute set globally as otherwise this will affect ALL devices and therefore ALL msg-commands in your automations).
  Note that use of RESIDENTS only makes sense together with ROOMMATE and or GUEST devices which still need to be created manually. See RESIDENTS Set commands addRoommate and addGuest respectively.
- createSwitcherDev <de|en>
  Creates a pre-configured Dummy device named HouseAnn and updates globalMsg attribute msgSwitcherDev to refer to it.

### netatmo

FHEM module for netatmo weather stations, thermostats and cameras.
Notes:

- JSON has to be installed on the FHEM host.
- You need to create an app here to get your client_id / client_secret.
  Request the full access scope including cameras and thermostats.

Define

`define <name> netatmo [ACCOUNT] <username> <password> <client_id> <client_secret>`
`define <name> netatmo <device>`
Defines a netatmo device.
If a netatmo device of the account type is created all fhem devices for the netatmo devices are automaticaly created (if autocreate is not disabled).
Examples:

`define netatmo netatmo ACCOUNT abc@test.com myPassword 2134123412399119d4123134 AkqcOIHqrasfdaLKcYgZasd987123asd`
`define netatmo netatmo 2f:13:2b:93:12:31`
`define netatmo netatmo MODULE 2f:13:2b:93:12:31 f1:32:b9:31:23:11`
`define netatmo netatmo HOME 1234567890abcdef12345678`
`define netatmo netatmo CAMERA 1234567890abcdef12345678 70:ee:12:34:56:78`
`define netatmo netatmo PERSON 1234567890abcdef12345678 01234567-89ab-cdef-0123-456789abcdef`

Webhook

`define netatmo netatmo WEBHOOK`
Set your URL in attribute webhookURL, events from cameras will be received insantly

Readings

Set

- autocreate
  Create fhem devices for all netatmo weather devices.
- autocreate_homes
  Create fhem devices for all netatmo homes, cameras and persons.
- autocreate_thermostats
  Create fhem devices for all netatmo relays and thermostats.
- autocreate_homecoachs
  Create fhem devices for all netatmo homecoachs.

Get
ACCOUNT

- devices
  list the netatmo weather devices for this account
- home
  list the netatmo home devices for this account
- update
  trigger a global update for dashboard data
- public [<address>] <args>
  no arguments -> get all public stations in a radius of 0.025° around global fhem latitude/longitude
  <rad> -> get all public stations in a radius of <rad>° around global fhem latitude/longitude
  <lat> <lon> [<rad>] -> get all public stations in a radius of 0.025° or <rad>° around <lat>/<lon>
  <lat1> <lon1> <lat2> <lon2> -> get all public stations in the area of <lat1> <lon2> <lat2> <lon2>
  if <address> is given then list stations in the area of this address. can be given as 5 digit german postal code or a: followed by a textual address. all spaces have to be replaced by a +.
  <lat> <lon> values can also be entered as a single coordinates parameter <lat>,<lon>

DEVICE/MODULE

- update
  update the device readings
- updateAll
  update the device readings after deleting all current readings

HOME

- update
  update the home events and all camera and person readings

CAMERA

- ping
  ping the camera and get the local command url
- live/_local
  get the playlist for live video (internet or local network)
- video/_local <video_id>
  get the playlist for a video id (internet or local network)

PRESENCE

- config
  read the camera config
- timelapse
  get the link for a timelapse video (local network)

PERSON

- update
  n/a

Attributes

- interval
  the interval in seconds used to check for new values.
- disable
  1 -> stop polling
- addresslimit
  maximum number of addresses to resolve in public station searches (ACCOUNT - default: 10)
- setpoint_duration
  setpoint duration in minutes (THERMOSTAT - default: 60)
- videoquality
  video quality for playlists (HOME - default: medium)
- webhookURL
  webhook URL - can include basic auth and ports: http://user:pass@your.url:8080/fhem/netatmo (WEBHOOK)
- webhookPoll
  poll home after event from webhook (WEBHOOK - default: 0)
- ignored_device_ids
  ids of devices/persons ignored on autocrate (ACCOUNT - comma separated)

### notice

`notice [confirm [value]|list [<keyword>]|reset [yes]|view <id> [noheader|[de|en]]]`
View and confirmation of system messages.
During an update or a system start from FHEM sometimes it is necessary to inform the user about important changes or additions. It may be necessary to confirm a system message by the user.
By entering the command '`notice`' a list of all messages is displayed. Are messages available in different languages, they are ordered by language.
Example:

> `

>         fhem> notice
>         ==> Language: de
>           ID                  Published  Expired    Confirmed  Description
>           advice-20130128-002 actually   never      not needed kurze beschreibung
>           update-20130128-002 31.01.2013 01.02.2013 no         kurze beschreibung

>         ==> Language: en
>           ID                  Published  Expired    Confirmed  Description
>           advice-20130128-001 actually   never      no         short description
>           advice-20130128-002 actually   never      not needed short description
>           update-20130128-001 actually   never      no         short description
>           update-20130128-002 31.01.2013 01.02.2013 no         short description

> `

By entering '`notice list <keyword>`' the output of the list contains only available messages that starts with '`<keyword>`'.
Example:

> `

>         fhem> notice list update
>         ==> Language: de
>           ID                  Published  Expired    Confirmed  Description
>           update-20130128-002 31.01.2013 01.02.2013 no         kurze beschreibung

>         ==> Language: en
>           ID                  Published  Expired    Confirmed  Description
>           update-20130128-001 actually   never      no         short description
>           update-20130128-002 31.01.2013 01.02.2013 no         short description

> `

To display a single message, enter the command '`notice view <id>`' where `id` is the Identifier of the message. You can use the optional parameter `noheader` or the language codes `de` or `en` to display the message without the header informations or in your prefered language if available.
Example:

> `

>         fhem> notice view advice-20130128-002 de
>         ID        : advice-20130128-002
>         From      : M. Fischer
>         Date      : 28.01.2013
>         Expire    : 0
>         Title     : kurze beschreibung
>         ### Start of Text
>         test-advice

>         dies ist ein test

>         001
>         ### End of Text

> `

If it is necessary to confirm a message, this is be done by entering '`notice confirm <id> [value]`'. The optional argument `value` will also be stored with the confirmation.
Example:

> `

>         fhem> notice confirm update-20130128-001 foo:bar
>         update-20130128-001 confirmed on 2013-01-29 20:58:57: foo:bar

> `

Sometimes it is necessary to reset all confirmations. This is be done by entering '`notice reset`'.
Example:

> `

>         fhem> notice reset
>         This command delete all confirmations.
>         If you really want to do this, call 'notice reset yes'

> `

For developers only:
`notice [condition <id>|get <keyword> <value>|position <id>]`
These arguments are normally not needed by any user.
A message may optionally contains one or more code snippets. The argument `condition` supplies the determined value(s) of the embedded test(s) as a key:value pair. If more than one pair returned, they they are seperated by `|`. It is possible to define your own rules for a condition, like `!empty` or `>>5` and so on. An example of a condition is shown in the below example message file. Example:

> `

>         fhem> notice condition update-20130127-001
>         configfile:./fhem.cfg|sendStatistics:never:!empty

> `

The argument `get`, followed by a `keyword` and a number from 0 to 8, returns a comma seperated list of message ids. The possible outputs are:

- `0 returns a list of all messages.`
- `1 returns a list of unconfirmed messages.`
- `2 returns a list of messages that are not expired.`
- `3 returns a list of messages that are not expired and unconfirmed.`
- `4 returns a list of published messages.`
- `5 returns a list of unconfirmed and published messages.`
- `6 returns a list of published messages that are not expired.`
- `7 returns a list of published, unconfirmed and not expired messages.`
- `8 returns a list of confirmed messages.`

Example:

> `

>         fhem> notice get all 2
>         advice-20130128-001,advice-20130128-002,update-20130128-001,update-20130128-002

> `

The argument `position` followed by an `<id>` returns the view position of a message if defined.
Example:

> `

>         fhem> notice position update-20130128-001
>         before

> `

Example of a message file:

> `

>         # FROM: M. Fischer
>         # DATE: 28.01.2013
>         # CONFIRM: 1
>         # PUBLISH: 31.01.2013
>         # EXPIRE: 01.02.2013
>         # KEY_1: sendStatistics
>         # VAL_1: AttrVal("global","sendStatistics",undef);
>         # CON_1: !empty
>         # KEY_2: configfile
>         # VAL_2: AttrVal("global","configfile",undef);
>         # POSITION: top
>         # TITLE_DE: kurze beschreibung
>         # NOTICE_DE
>         Hinweis:

>         dies ist ein test
>         # TITLE_EN: short description
>         # NOTICE_EN
>         Advice:

>         this is a test

> `

The keywords '`FROM, DATE, CONFIRM, PUBLISH, EXPIRE, TITLE_DE, TITLE_EN, NOTICE_DE, NOTICE_EN`' are fixed. It is possible to add any key:value string to these files. Also it is possible to set only one or both keywords of '`TITLE_DE, TITLE_EN`' and '`NOTICE_DE, NOTICE_EN`'.

### notify

Define

`define <name> notify <pattern> <command>`
Execute a command when received an event for the definition `<pattern>`. 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). See the trigger command for testing it. Examples:

`define b3lampV1 notify btn3 set lamp $EVENT`
`define b3lampV2 notify btn3 { fhem "set lamp $EVENT" }`
`define b3lampV3 notify btn3 "/usr/local/bin/setlamp "$EVENT""`
`define b3lampV3 notify btn3 set lamp1 $EVENT;;set lamp2 $EVENT`
`define wzMessLg notify wz:measured.* "/usr/local/bin/logfht $NAME "$EVENT""`
`define LogUndef notify global:UNDEFINED.* "send-me-mail.sh "$EVENT""`

Notes:

- `<pattern>` is either the name of the triggering device, or `devicename:event`.
- `<pattern>` must completely (!) match either the device name, or the compound of the device name and the event. To identify the events use the inform command from the telnet prompt or the "Event Monitor" link in the browser (FHEMWEB), and wait for the event to be printed. See also the eventTypes device.
- in the command section you can access the event:
  - The variable $EVENT will contain the complete event, e.g. `measured-temp: 21.7 (Celsius)`
  - $EVTPART0,$EVTPART1,$EVTPART2,etc contain the space separated event parts (e.g. `$EVTPART0="measured-temp:", $EVTPART1="21.7", $EVTPART2="(Celsius)"`. This data is available as a local variable in perl, as environment variable for shell scripts, and will be textually replaced for FHEM commands.
  - $NAME and $TYPE contain the name and type of the device triggering the event, e.g. myFht and FHT
- Note: the following is deprecated and will be removed in a future release. It is only active for featurelevel up to 5.6. The described replacement is attempted if none of the above variables ($NAME/$EVENT/etc) found in the command.
  - The character `%` will be replaced with the received event, e.g. with `on` or `off` or `measured-temp: 21.7 (Celsius)`
    It is advisable to put the `%` into double quotes, else the shell may get a syntax error.
  - The character @ will be replaced with the device name.
  - To use % or @ in the text itself, use the double mode (%% or @@).
  - Instead of % and @, the parameters %EVENT (same as %), %NAME (same as @) and %TYPE (contains the device type, e.g. FHT) can be used. The space separated event "parts" are available as %EVTPART0, %EVTPART1, etc. A single % looses its special meaning if any of these parameters appears in the definition.
- Following special events will be generated for the device "global"
  - 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.
- Notify can be used to store macros for manual execution. Use the trigger command to execute the macro. E.g.
  `fhem> define MyMacro notify MyMacro { Log 1, "Hello"}`
  `fhem> trigger MyMacro`

Set

- addRegexpPart <device> <regexp>
  add a regexp part, which is constructed as device:regexp. The parts are separated by |. Note: as the regexp parts are resorted, manually constructed regexps may become invalid.
- removeRegexpPart <re>
  remove a regexp part. Note: as the regexp parts are resorted, manually constructed regexps may become invalid.
  The inconsistency in addRegexpPart/removeRegexPart arguments originates from the reusage of javascript functions.
- inactive
  Inactivates the current device. Note the slight difference to the disable attribute: using set inactive the state is automatically saved to the statefile on shutdown, there is no explicit save necesary.
  This command is intended to be used by scripts to temporarily deactivate the notify.
  The concurrent setting of the disable attribute is not recommended.
- active
  Activates the current device (see inactive).

Get

N/A

Attributes

- disable
- disabledForIntervals
- addStateEvent
  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". In some circumstances it is desireable to get the event without "state: " stripped. In such a case the addStateEvent attribute should be set to 1 (default is 0, i.e. strip the "state: " string).
  Note 1: you have to set this attribute for the event "receiver", i.e. notify, FileLog, etc.
  Note 2: this attribute will only work for events generated by devices supporting the readingFnAttributes.
- forwardReturnValue
  Forward the return value of the executed command to the caller, default is disabled (0). If enabled (1), then e.g. a set command which triggers this notify will also return this value. This can cause e.g FHEMWEB to display this value, when clicking "on" or "off", which is often not intended.
- readLog
  Execute the notify for messages appearing in the FHEM Log. The device in this case is set to the notify itself, e.g. checking for the startup message looks like:
  `define n notify n:.*Server.started.* { Log 1, "Really" }
  attr n readLog`
- perlSyntaxCheck
  by setting the global attribute perlSyntaxCheck, a syntax check will be executed upon definition or modification, if the command is perl and FHEM is already started.

### panStamp

The panStamp is a family of RF devices sold by panstamp.com. It is possible to attach more than one device in order to get better reception, fhem will filter out duplicate messages.
This module provides the IODevice for the SWAP modules that implement the SWAP protocoll to communicate with the individual moths in a panStamp network.
Note: currently only panSticks are know to work. The panStamp shield for a Rasperry Pi is untested.
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> panStamp <device> [<address> [<channel> [<syncword>]]]`
USB-connected devices:

<device> specifies the serial port to communicate with the panStamp. 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 panStamp by the following command:

modprobe usbserial vendor=0x0403 product=0x6001

In this case the device is most probably /dev/ttyUSB0.
You can also specify a baudrate if the device name contains the @ character, e.g.: /dev/ttyACM0@38400
If the baudrate is "directio" (e.g.: /dev/ttyACM0@directio), then the perl module Device::SerialPort is not needed, and fhem opens the device with simple file io. This might work if the operating system uses sane defaults for the serial parameters, e.g. some Linux distributions and OSX.

The address is a 2 digit hex number to identify the moth in the panStamp network. The default is 01.
The channel is a 2 digit hex number to define the channel. the default is 00.
The syncword is a 4 digit hex number to identify the panStamp network. The default is B547.
Uppon initialization a broadcast message is send to the panStamp network to try to autodetect and autocreate all listening SWAP devices (i.e. all devices not in power down mode).

Set

- raw data
  send raw data to the panStamp to be transmitted over the RF link.

Get

Attributes

### pilight

#### Define

`define <name> pilight <protocol>`
Defines a module for setting pilight compartible switches on or off. See Sweetpi.
Supported protocols: kaku_switch, quigg_*, elro_he, elro_hc, silvercrest, pollin, brennenstuhl, mumbi, impuls, rsl366, rev1_switch, rev2_switch, clarus_switch, raw, and intertechno_old. If you need more, just write an issue!
Example:

`define Weihnachtsbaum pilight kaku_switch`
`attr Weihnachtsbaum housecode 12323578`
`attr Weihnachtsbaum unitcode 0`

If your pilight server does not run on localhost, please set both the attributes remote_ip and remote_port. If you are running pilight >3.0, then please define the port used by pilight settings: http://www.pilight.org/getting-started/settings/; fhem-plight uses 5000 by default.
This version is written for pilight 6.0. If you run a prior version, please set the following attribute: `attr Weihnachtsbaum useOldVersion 1`

#### Attributes

- `attr <name> protocol <string>`
  Protocol used in pilight, e.g. "kaku_switch"
- `attr <name> housecode <string>`
  Housecode used in pilight (for protocol kaku*, clarus_switch, rev1_switch, rev2_switch, rev3_switch, quigg_switch, quigg_gt1000, quigg_gt7000)
- `attr <name> systemcode <string>`
  Systemcode of your switch (for protocol elso, elro_he, elro_hc, silvercrest, impuls, rsl366, pollin, mumbi, brennenstuhl, intertechno_old)
- `attr <name> unitcode <string>`
  Unit code/device code used in pilight (all protocols)
- `attr <name> rawCode <string>`
  Raw code to send on/off-command with protocol "raw"
- `attr <name> remote_ip <string>`
  Remote IP of you pilight server (127.0.0.1 is default)
- `attr <name> remote_port <string>`
  Remote port of you pilight server (5000 is default)
- `attr <name> rawCodeOn <string>`
  Raw command to send to switch device ON (only used with protocol 'raw')
- `attr <name> rawCodeOff <string>`
  Raw command to send to switch device OFF (only used with protocol 'raw')

### pilight_contact

pilight_contact represents a contact sensor receiving data from pilight
You have to define the base device pilight_ctrl first.
Further information to pilight: http://www.pilight.org/
Define

`define <name> pilight_contact protocol id [unit]`
Example:

`define myctrl pilight_contact arctech_contact 12836682 1`

Readings

- state
  present the current state (open|closed)

### pilight_ctrl

pilight_ctrl is the base device for the communication (sending and receiving) with the pilight-daemon.
You have to define client devices e.q. pilight_switch for switches.
Further information to pilight: http://www.pilight.org/
Further information to pilight protocols: http://wiki.pilight.org/doku.php/protocols#protocols
Currently supported:

- Switches:
- Dimmers:
- Temperature and humitity sensors

Define

`define <name> pilight_ctrl ip:port [api]` ip:port is the IP address and port of the pilight-daemon
api specifies the pilight api version - default 6.0
Example:

`define myctrl pilight_ctrl localhost:5000 5.0`
`define myctrl pilight_ctrl 192.168.1.1:5000`

Set

- reset Reset the connection to the pilight daemon
- disconnectDiconnect from pilight daemon and do not reconnect automatically

Readings

- rcv_raw
  The last complete received message in json format.

Attributes

- ignoreProtocol
  Comma separated list of protocol:id combinations to ignore.
  protocol:* ignores the complete protocol.
  * All incomming messages will be ignored. Only protocol id combinations from defined submodules will be accepted
  Example:
- `ignoreProtocol tfa:0`
- `ignoreProtocol tfa:*`
- `ignoreProtocol *`
- brands
  Comma separated list of :<replace> combinations to rename protocol names.
  pilight uses different protocol names for the same protocol e.q. arctech_switch and kaku_switch
  Example: `brands archtech:kaku`
- ContactAsSwitch
  Comma separated list of ids which correspond to a contact but will be interpreted as switch.
  In this case opened will be interpreted as on and closed as off.
  Example: `ContactAsSwitch 12345`
- SendTimeout
  Timeout [s] for aborting sending commands (non blocking) - default 1s

### pilight_dimmer

pilight_dimmer represents a dimmmer controled with\from pilight
You have to define the base device pilight_ctrl first.
Further information to pilight: http://www.pilight.org/
Supported dimmers: http://wiki.pilight.org/doku.php/protocols#dimmers
It is possible to add the screen feature to a dimmer. So you can change the dimlevel by set 'up' or 'down'.
If you push up or down on the remote control the dimlevel will be changed by dimlevel_step.
Further it is possible to define a simulated dimmer with a screen and switch protocol. See example three.
That means if you change the dimlevel a up or down command will be send n times to dim the device instead of send a dimlevel directly.
Define

`define <name> pilight_dimmer protocol id unit [protocol]`
The second protocol is optional. With it you can add the pilight screen feature (up|down) Example:

`define myctrl pilight_dimmer kaku_dimmer 13483668 0`
`define myctrl pilight_dimmer kaku_dimmer 13483668 0 kaku_screen` - Dimmer with screen feature
`define myctrl pilight_dimmer quigg_screen 1 0 quigg_gt7000` - Simulated dimmer with screen feature

Set

- on
- off
- up only if defined with screen protocol
- down only if defined with screen protocol
- dimlevel
- set extensions are supported

Readings

- state
  state of the dimmer on or off
- dimlevel
  dimlevel of the dimmer

Attributes

- dimlevel_max_device
  Maximum of the dimlevel of the device - default 15
  Have to be less or equal than dimlevel_max
- dimlevel_max
  Maximum of the dimlevel in FHEM - default dimlevel_max_device
- dimlevel_step
  Step of the dimlevel - default 1
- dimlevel_on
  Change dimlevel to value if on set - default no changing
  Could be a numeric value or dimlevel_max
- dimlevel_off
  Change dimlevel to value if off set - default no changing

### pilight_raw

With pilight_raw it si possible to send raw codes
You have to define the base device pilight_ctrl first.
Define

`define <name> pilight_raw`

Set

- on Send 'onCode' as raw code
- off Send 'offCode' as raw code
- code <value> Send <value> as raw code
- set extensions are supported

Readings

- state
  state on or off

Attributes

- onCode
  raw code for state on
- onCode
  raw code for state off
- sendCount
  How many times the command is send. Default: 1

### pilight_smoke

pilight_smoke represents a smoke sensor receiving data from pilight
You have to define the base device pilight_ctrl first.
Further information to pilight: http://www.pilight.org/
Define

`define <name> pilight_smoke protocol id`
Example:

`define myctrl pilight_smoke secudo_smoke_sensor 0`

Readings

- state
  present the current state (alarm|none)

Attributes

- resetTime
  Time [sec] to reset the state to none.

### pilight_switch

pilight_switch represents a switch controled with\from pilight
You have to define the base device pilight_ctrl first.
Further information to pilight: http://www.pilight.org/
Supported switches: http://wiki.pilight.org/doku.php/protocols#switches
Define

`define <name> pilight_switch protocol id unit`
Example:

`define myctrl pilight_switch kaku_switch_old 0 0`

Set

- on
- off
- set extensions are supported

Readings

- state
  state of the switch on or off

Attributs

- IODev
- sendCount
  How many times the command is send. Default: 1

### pilight_temp

pilight_temp represents a temperature and humidity sensor receiving data from pilight
You have to define the base device pilight_ctrl first.
Further information to pilight: http://www.pilight.org/
Supported Sensors: http://wiki.pilight.org/doku.php/protocols#weather_stations
Define

`define <name> pilight_temp protocol id`
Example:

`define myctrl pilight_temp alecto_wsd17 100`

Readings

- state
  present the current temperature
- temperature
  present the current temperature
- humidity
  present the current humidity (if sensor support it)
- battery
  present the battery state of the senor (if sensor support it)
- pressure
  present the pressure state of the senor (if sensor support it)
- windavg
  present the average wind speed state of the senor (if sensor support it)
- winddir
  present the wind direction state of the senor (if sensor support it)
- windgust
  present the wind gust state of the senor (if sensor support it)

Attributes

- corrTemp
  A factor (e.q. 0.1) to correct the temperture value. Default: 1 temperature = corrTemp * piligt_temp + offsetTemp
- offsetTemp
  An offset for temperature value. Default: 0 temperature = corrTemp * piligt_temp + offsetTemp
- corrHumidity
  A factor (e.q. 0.1) to correct the humidity value. Default: 1 humidity = corrHumidity * piligt_humidity + offsetHumidity
- offsetHumidity
  An offset for humidity value. Default: 0 humidity = corrHumidity * piligt_humidity + offsetHumidity

### ping

This module provides a simple "ping" function for testing the state of a remote network device.

It allows for alerts to be triggered when devices cannot be reached using a notify function.

Define

`define <name> ping <host/ip> <mode> <timeout>`

Specifies the ping device.
<host/ip> is the hostname or IP address of the Bridge.

Specifies ping mode.
<mode> One of: tcp|udp|icmp. Read the perl docs for more detail: http://perldoc.perl.org/Net/Ping.html

Timeout.
<timeout> is the maximum time to wait for each ping.

Readings

- state
  [Initialized|ok|unreachable]: Shows reachable status check every 10 (checkInterval) seconds.

Attributes

- checkInterval
  Default: 10s. Time after the bridge connection is re-checked.
- minFailCount
  Default: 1. Number of failures before reporting "unreachable".

### plex

This module allows you to control and receive events from plex.
Notes:

- IO::Socket::Multicast is needed to use server and client autodiscovery.
- As far as possible alle get and set commands are non-blocking. Any output is displayed asynchronous and is using fhemweb popup windows.

Define

`define <name> plex [<server>]`

Set

- play [<server> [<item>]]
- resume [<server>] <item>]
- pause [<type>]
- stop [<type>]
- skipNext [<type>]
- skipPrevious [<type>]
- stepBack [<type>]
- stepForward [<type>]
- seekTo <value> [<type>]
- volume <value> [<type>]
- shuffle 0|1 [<type>]
- repeat 0|1|2 [<type>]
- mirror [<server>] <item>
  show preplay screen for <item>
- home
- music
- showAccount
  display obfuscated user and password in cleartext
- playlistCreate [<server>] <name>
- playlistAdd [<server>] <key> <keys>
- playlistRemove [<server>] <key> <keys>
- unwatched [[<server>] <items>]
- watched [[<server>] <items>]
- autocreate <machineIdentifier>
  create device for remote/shared server

Get

- [<server>] ls [<path>]
  browse the media library. eg:
  `get <plex> ls`

        Plex Library
        key                                 type       title
        1                                   artist       Musik
        2                      ...

  `get <plex> ls /1`

        Musik
        key                                 type       title
        all                                            All Artists
        albums                                         By Album
        collection                                     By Collection
        decade                                         By Decade
        folder                                         By Folder
        genre                                          By Genre
        year                                           By Year
        recentlyAdded                                  Recently Added
        search?type=9                                  Search Albums...
        search?type=8                                  Search Artists...
        search?type=10                                 Search Tracks...

  `get <plex> ls /1/albums`

        Musik ; By Album
        key                                  type       title
        /library/metadata/133999/children   album       ...
        /library/metadata/134207/children   album       ...
        /library/metadata/168437/children   album       ...
        /library/metadata/82906/children    album       ...
        ...

  `get <plex> ls /library/metadata/133999/children`

        ...

  if used from fhemweb album art can be displayed and keys and other items are klickable.
- [<server>] search <keywords>
  search the media library for items that match <keywords>
- [<server>] onDeck
  list the global onDeck items
- [<server>] recentlyAdded
  list the global recentlyAdded items
- [<server>] detail <key>
  show detail information for media item <key>
- [<server>] playlists
  list playlists
- [<server>] m3u [album]
  creates an album playlist in m3u format. can be used with other players like sonos.
- [<server>] pls [album]
  creates an album playlist in pls format. can be used with other players like sonos.
- clients
  list the known clients
- servers
  list the known servers
- pin
  get a pin for authentication at https://plex.tv/pin

Attr

- httpPort
- ignoredClients
- ignoredServers
- removeUnusedReadings
- user
- password
  user and password of a myPlex account. required if plex home is used. both are stored obfuscated

### powerMap

(en | de)

powerMap will help to determine current power consumption and calculates energy consumption either when power changes or within regular interval.
These new values may be used to collect energy consumption for devices w/o power meter (e.g. fridge, lighting or FHEM server) and for further processing using module ElectricityCalculator.
Define

`define <name> powerMap`
You may only define one single instance of powerMap.

Set

- `assign <devspec>`
  Adds pre-defined powerMap attributes to one or more devices for further customization.

Get

- `devices`
  Lists all devices having set an attribute named 'powerMap'.

Readings

Device specific readings:

- `pM_energy`
  A counter for consumed energy in Wh.
  Hint: In order to have the calculation working, attribute `timestamp-on-change-reading` may not be set for reading pM_energy!
- `pM_energy_begin`
  Unix timestamp when collection started and device started to consume energy for the very first time.
- `pM_consumption`
  Current power consumption of device in W.

Attribute

- `disable 1`
  No readings will be created or calculated by this module.
- `powerMap_eventChainWarnOnly <1>`
  When set, event chain will NOT be repaired automatically if readings were found to be required for powerMap but their events are currently suppressed because they are either missing from attributes event-on-change-reading or event-on-update-reading. Instead, manual intervention is required.
- `powerMap_interval <seconds>`
  Interval in seconds to calculate energy.
  Default value is 900 seconds.
- `powerMap_noEnergy 1`
  No energy consumption will be calculated for that device.
- `powerMap_noPower 1`
  No power consumption will be determined for that device and consequently no energy consumption at all.
- `powerMap_rname_E`
  Sets reading name for energy consumption.
  Default value is 'pM_energy'.
- `powerMap_rname_P`
  Sets reading name for power consumption.
  Default value is 'pM_consumption'.
- `powerMap

              {
                '<reading>' => {
                  '<value>' => <power>,
                  '<value>' => <power>,
                   ...
                },

                '<reading>' {
                  '<value>' => <power>,
                  '<value>' => <power>,
                   ...
                },

                ...
              }

  ` (device specific)
  A Hash containing event(=reading) names and possible values of it. Each value can be assigned a corresponding power consumption.
  For devices with dimming capability intemediate values will be linearly interpolated. For this to work two separate numbers will be sufficient.
  Text values will automatically get any numbers extracted from it and be used for interpolation. (example: dim50% will automatically be interpreted as 50).
  In addition "off" and "on" will be translated to 0 and 100 respectively.
  If the value cannot be interpreted in any way, 0 power consumption will be assumed.
  Explicitly set definitions in powerMap attribute always get precedence.
  In case several power values need to be summarized, the name of other readings may be added after number value, separated by comma. The current status of that reading will then be considered for total power calculcation. To consider all readings powerMap knows, just add an *.
  Example for FS20 socket:
  `

                'state' => {
                  '0' => 0,
                  '100' => 60,
                },

  `
  Example for HUE white light bulb:
  `

                'pct' => {
                  '0' => 0.4,
                  '10' => 1.2,
                  '20' => 1.7,
                  '30' => 1.9,
                  '40' => 2.3,
                  '50' => 2.7,
                  '60' => 3.4,
                  '70' => 4.7,
                  '80' => 5.9,
                  '90' => 7.5,
                  '100' => 9.2,
                },
                'state' => {
                  'unreachable' => 0,
                  '*' => 'pct',
                },

  `

### rain

Rain calculations. Offers different values from a rain sensor.
Define

`define <name> rain <devicename-regex> [<rain_name> <israining_name> <new_name>]`

Calculates rain values for device <devicename-regex> from incremental rain-value and israining-state and write it to some new readings named rain_calc_???????. If optional <rain_name>, <israining_name> and <new_name> is specified then read rain from reading <rain_name>, israining from reading <israining_name> and write the calculated rain to reading <new_name>.

The following values are generated:

- rain_calc_all --> all values in one line
- rain_calc_d_curr --> liter rain at the current day (from 7:30 local time)
- rain_calc_d_last --> liter rain of 24h before 7:30 local time
- rain_calc_d_start --> first incremental rain value from the rain device after 7:30 local time
- rain_calc_h_curr --> liter rain at the current hour (from XX:30)
- rain_calc_h_last --> liter rain of 1 hour before the last XX:30 time
- rain_calc_h_start --> first incremental rain value from the rain device after last XX:30
- rain_calc_now_diff --> fallen rain in liter since last value from rain device
- rain_calc_now_rate --> fallen rain in liter/hour since last value from rain device

Example:

        # Compute the rain for the rain/israining
        # events of the ks300 device and generate reading rain_calc.
        define rain_ks300 rain ks300

Set

N/A

Get

N/A

Attributes

- disable
- DontUseIsRaining 0/1
  Don't use the devicevalue IsRaining, if set to 1
- DayChangeTime HHMM
  Change the default (day)time of the 'set value to zero' time (use the timecode as four digits!)
  The minutevalue is used to set the (hour)time of the 'set value to zero' time
- CorrectionValue 1
  Use this value if you wish to do a correction of the rain-device-values. It is used as an factor. The value 1 will not change anything.

### readingsChange

Define

`define <name> readingsChange <device> <readingName> <toReplace> <replaceWith>"`
Change the content of a reading if it changes, with the perl string substitute mechanism. Note: As some modules rely on the known format of some readings, changing such readings may cause these modules to stop working.
<device>, <readingName> and <toReplace> are regular expressions, and are not allowed to contain whitespace. If replaceWith is enclosed in {}, then the content will be executed as a perl expression for each match.
Notes:

- after a Reading is set by a module, first the event-* attributes are evaluated, then userReadings, then stateFormat, then the readingsChange definitions (in alphabetical order), and after this the notifies, FileLogs, etc. again in alphabetical order.
- if stateFormat for the matched device is set, then it will be executed multiple times: once before the readingsChange, and once for every matching readingsChange.

Examples:

`# shorten the reading power 0.5 W previous: 0 delta_time: 300
# to just power 0.5 W
define pShort readingsChange pm power (.*W).* $1
# format each decimal number in the power reading to 2 decimal places
define p2dec readingsChange pm power (\d+\.\d+) {sprintf("%0.2f", $1)}`

Set

N/A

Get

N/A

Attributes

- disable
- disabledForIntervals

### readingsGroup

Displays a collection of readings from on or more devices.
Define

`define <name> readingsGroup <device>[:regex] [<device-2>[:regex-2]] ... [<device-n>[:regex-n]]`
Notes:

- <device> can be of the form INTERNAL=VALUE where INTERNAL is the name of an internal value and VALUE is a regex.
- <device> can be of the form ATTRIBUTE&VALUE where ATTRIBUTE is the name of an attribute and VALUE is a regex.
- <device> can be of the form <STRING> or <{perl}> where STRING or the string returned by perl is inserted as a line in the readings list. skipped if STRING is undef.
- <device> can be a devspec (see devspec) with at least one FILTER expression.
- If regex is a comma separatet list the reading values will be shown on a single line.
- If regex starts with a '+' it will be matched against the internal values of the device instead of the readings.
- If regex starts with a '?' it will be matched against the attributes of the device instead of the readings.
- If regex starts with a '!' the display of the value will be forced even if no reading with this name is available.
- If regex starts with a '$' the calculation with value columns and rows is possible.
- regex can be of the form <regex>@device to use readings from a different device.
  if the device name part starts with a '!' the display will be foreced. use in conjunction with ! in front of the reading name.
- regex can be of the form <regex>@{perl} to use readings from a different device.
- regex can be of the form <STRING> or <{perl}[@readings]> where STRING or the string returned by perl is inserted as a reading or:
  - the item will be skipped if STRING is undef
  - if STRING is br a new line will be started
  - if STRING is hr a horizontal line will be inserted
  - if STRING is tfoot the table footer is started
  - if STRING is of the form %ICON[%CMD] ICON will be used as the name of an icon instead of a text and CMD as the command to be executed if the icon is clicked. also see the commands attribute.
  if readings is given the perl expression will be reevaluated during longpoll updates.
- If the first regex is '@<index>' it gives the index of the following regex by which the readings are to be grouped. if capture groups are used they can be refferenced by #<number>. eg:
  `<IP-Adress><Hostname><MAC><Vendor>
  nmap:@2,<#1>,(.*)_hostname,#1_macAddress,#1_macVendor`
- For internal values and attributes longpoll update is not possible. Refresh the page to update the values.
- the <{perl}> expression is limited to expressions without a space. it is best just to call a small sub in 99_myUtils.pm instead of having a compex expression in the define.

Examples:

`define batteries readingsGroup .*:battery`
`define temperatures readingsGroup s300th.*:temperature`
`define temperatures readingsGroup TYPE=CUL_WS:temperature`
`define culRSSI readingsGroup cul_RSSI=.*:+cul_RSSI`
`define heizung readingsGroup t1:temperature t2:temperature t3:temperature
attr heizung notime 1
attr heizung mapping {'t1.temperature' => 'Vorlauf', 't2.temperature' => 'R&uuml;cklauf', 't3.temperature' => 'Zirkulation'}
attr heizung style style="font-size:20px"
define systemStatus readingsGroup sysstat
attr systemStatus notime 1
attr systemStatus nostate 1
attr systemStatus mapping {'load' => 'Systemauslastung', 'temperature' => 'Systemtemperatur in &deg;C'}
define Verbrauch readingsGroup TYPE=PCA301:state,power,consumption
attr Verbrauch mapping %ALIAS
attr Verbrauch nameStyle style="font-weight:bold"
attr Verbrauch style style="font-size:20px"
attr Verbrauch valueFormat {power => "%.1f W", consumption => "%.2f kWh"}
attr Verbrauch valueIcon { state => '%devStateIcon' }
attr Verbrauch valueStyle {($READING eq "power" && $VALUE > 150)?'style="color:red"':'style="color:green"'}
define rg_battery readingsGroup TYPE=LaCrosse:[Bb]attery
attr rg_battery alias Batteriestatus
attr rg_battery commands { "battery.low" => "set %DEVICE replaceBatteryForSec 60" }
attr rg_battery valueIcon {'battery.ok' => 'batterie', 'battery.low' => 'batterie@red'}
define rgMediaPlayer readingsGroup myMediaPlayer:currentTitle,<>,totaltime,
,currentAlbum,<>,currentArtist,
,volume,<{if(ReadingsVal($DEVICE,"playStatus","")eq"paused"){"%rc_PLAY%set+$DEVICE+play"}else{"%rc_PAUSE%set+$DEVICE+pause"}}@playStatus>,playStatus
attr rgMediaPlayer commands { "playStatus.paused" => "set %DEVICE play", "playStatus.playing" => "set %DEVICE pause" }
attr rgMediaPlayer mapping
attr rgMediaPlayer notime 1
attr rgMediaPlayer valueFormat { "volume" => "Volume: %i" }
#attr rgMediaPlayer valueIcon { "playStatus.paused" => "rc_PLAY", "playStatus.playing" => "rc_PAUSE" }
`

Set

- hide
  will hide all visible instances of this readingsGroup
- show
  will show all visible instances of this readingsGroup
- toggle
  will toggle the hidden/shown state of all visible instances of this readingsGroup
- toggle2
  will toggle the expanded/collapsed state of all visible instances of this readingsGroup

Get

Attributes

- alwaysTrigger
  1 -> alwaysTrigger update events. even if not visible.
  2 -> trigger events for calculated values.
- disable
  1 -> disable notify processing and longpoll updates. Notice: this also disables rename and delete handling.
  2 -> also disable html table creation
  3 -> also disable html creation completely
- sortDevices
  1 -> sort the device lines alphabetically. use the first of sortby or alias or name that is defined for each device.
- noheading
  If set to 1 the readings table will have no heading.
- nolinks
  Disables the html links from the heading and the reading names.
- nostate
  If set to 1 the state reading is excluded.
- nonames
  If set to 1 the reading name / row title is not displayed.
- notime
  If set to 1 the reading timestamp is not displayed.
- mapping
  Can be a simple string or a perl expression enclosed in {} that returns a hash that maps reading names to the displayed name. The keys can be either the name of the reading or <device>.<reading> or <reading>.<value> or <device>.<reading>.<value>. %DEVICE, %ALIAS, %ROOM, %GROUP, %ROW and %READING are replaced by the device name, device alias, room attribute, group attribute and reading name respectively. You can also prefix these keywords with $ instead of %. Examples:
  `attr temperatures mapping $DEVICE-$READING`
  `attr temperatures mapping {temperature => "%DEVICE Temperatur"}`
- separator
  The separator to use between the device alias and the reading name if no mapping is given. Defaults to ':' a space can be enteread as `&nbsp;`
- setList
  Space separated list of commands, which will be returned upon "set name ?", so the FHEMWEB frontend can construct a dropdown and offer on/off switches. set commands not in this list will be rejected.
- setFn
  perl expresion that will be executed for the commands from the setList. has access to $CMD and $ARGS.
- style
  Specify an HTML style for the readings table, e.g.:
  `attr temperatures style style="font-size:20px"`
- cellStyle
  Specify an HTML style for a cell of the readings table. regular rows and colums are counted starting with 1, the row headings are column number 0. perl code has access to $ROW and $COLUMN. keys for hash lookup can be r:#, c:# or r:#,c:# , e.g.:
  `attr temperatures cellStyle { "c:0" => 'style="text-align:right"' }`
- nameStyle
  Specify an HTML style for the reading names, e.g.:
  `attr temperatures nameStyle style="font-weight:bold"`
- valueStyle
  Specify an HTML style for the reading values, e.g.:
  `attr temperatures valueStyle style="text-align:right"`
- valueColumn
  Specify the minimum column in which a reading should appear.
  `attr temperatures valueColumn { temperature => 2 }`
- valueColumns
  Specify an HTML colspan for the reading values, e.g.:
  `attr wzReceiverRG valueColumns { eventdescription => 'colspan="4"' }`
- valueFormat
  Specify an sprintf style format string used to display the reading values. If the format string is undef this reading will be skipped. Can be given as a string, a perl expression returning a hash or a perl expression returning a string, e.g.:
  `attr temperatures valueFormat %.1f °C`
  `attr temperatures valueFormat { temperature => "%.1f °C", humidity => "%i %" }`
  `attr temperatures valueFormat { ($READING eq 'temperature')?"%.1f °C":undef }`
- valuePrefix
  text to be prepended to the reading value
- valueSuffix
  text to be appended after the reading value
  `attr temperatures valueFormat { temperature => "%.1f", humidity => "%i" }`
  `attr temperatures valueSuffix { temperature => "°C", humidity => " %" }`
- nameIcon
  Specify the icon to be used instead of the reading name. Can be a simple string or a perl expression enclosed in {} that returns a hash that maps reading names to the icon name. e.g.:
  `attr devices nameIcon $DEVICE`
- valueIcon
  Specify an icon to be used instead of the reading value. Can be a simple string or a perl expression enclosed in {} that returns a hash that maps reading value to the icon name. e.g.:
  `attr devices valueIcon $VALUE`
  `attr devices valueIcon {state => '%VALUE'}`
  `attr devices valueIcon {state => '%devStateIcon'}`
  `attr rgMediaPlayer valueIcon { "playStatus.paused" => "rc_PLAY", "playStatus.playing" => "rc_PAUSE" }`
- commands
  Can be used in to different ways:
  - To make a reading or icon clickable by directly specifying the command that should be executed. eg.:
    `attr rgMediaPlayer commands { "playStatus.paused" => "set %DEVICE play", "playStatus.playing" => "set %DEVICE pause" }`
  - Or if the mapped command is of the form <command>:[<modifier>] then the normal FHEMWEB webCmd widget for <modifier> will be used for this command. if <modifier> is omitted then the FHEMWEB lookup mechanism for <command> will be used. eg:
    `attr rgMediaPlayer commands { volume => "volume:slider,0,1,100" }`
    `attr lights commands { pct => "pct:", dim => "dim:" }`
  - commands can be used for attribtues. eg:
    `attr <rg> commands { disable => "disable:" }`
- visibility
  if set to hidden or hideable will display a small button to the left of the readingsGroup name to expand/hide the contents of the readingsGroup. if a readingsGroup is expanded then all others in the same group will be hidden.
  hidden -> default state is hidden but can be expanded
  hideable -> default state is visible but can be hidden
  if set to collapsed or collapsible readingsGroup will recognise the specials <->,<+> and <+-> as the first elements of a line to add a + or - symbol to this line. clicking on the + or - symbol will toggle between expanded and collapsed state. if a readingsGroup is expanded then all others in the same group will be collapsed.
  - -> line will be visible in expanded state
  + -> line will be visible in collapsed state
  +- -> line will be visible in both states
  collapsed -> default state is collapsed but can be expanded
  collapsible -> default state is visible but can be collapsed

- headerRows
- sortColumn
  > 0 -> automatically sort the table by this column after page loading 0 -> do not sort automatically but allow sorting of the table by clicking on a column header < 0 -> automatically sort the table in reverse by this column after page loading
- perlSyntaxCheck

For the hash version of all mapping attributes it is possible to give a default value with `{ '' => <default> }`.
The style attributes can also contain a perl expression enclosed in {} that returns the style string to use. For nameStyle and valueStyle The perl code can use $DEVICE,$READING,$VALUE and $NUM, e.g.:

`attr batteries valueStyle {($VALUE ne "ok")?'style="color:red"':'style="color:green"'}`
`attr temperatures valueStyle {($DEVICE =~ m/aussen/)?'style="color:green"':'style="color:red"'}`

Note: Only valueStyle, valueFomat, valueIcon and <{...}@reading> are evaluated during longpoll updates and valueStyle has to return a non empty style for every possible value. All other perl expressions are evaluated only once during html creation and will not reflect value updates with longpoll. Refresh the page to update the dynamic style. For nameStyle the color attribut is not working at the moment, the font-... and background attributes do work.
Calculation: to be written...
eg: `define rg readingsGroup .*:temperature rg:$avg`
please see a description in the wiki

### readingsHistory

Displays a history of readings from on or more devices.
Define

`define <name> readingsHistory [<device>[:regex] [<device-2>[:regex-2] ... [<device-n>[:regex-n]]]]`
Notes:

- <device> can be of the form INTERNAL=VALUE where INTERNAL is the name of an internal value and VALUE is a regex.
- If regex is a comma separatet list it will be used as an enumeration of allowed readings.
- if no device/reading argument is given only lines with 'set <device> add ...' are displayed.

Examples:

Set

- add ...
  directly add text as new line to history.
- clear
  clear the history.

Get

- history
  list history

Attributes

- alwaysTrigger
  1 -> alwaysTrigger update events. even if not visible.
- disable
  1 -> disable notify processing and longpoll updates. Notice: this also disables rename and delete handling.
  2 -> also disable html table creation
  3 -> also disable html creation completely
- noheading
  If set to 1 the readings table will have no heading.
- nolinks
  Disables the html links from the heading and the reading names.
- notime
  If set to 1 the reading timestamp is not displayed.
- mapping
  Can be a simple string or a perl expression enclosed in {} that returns a hash that maps device names to the displayed name. The keys can be either the name of the reading or <device>.<reading>. %DEVICE, %ALIAS, %ROOM and %GROUP are replaced by the device name, device alias, room attribute and group attribute respectively. You can also prefix these keywords with $ instead of %.
- style
  Specify an HTML style for the readings table, e.g.:
  `attr history style style="font-size:20px"`
- timestampFormat
  POSIX strftime compatible string for used as the timestamp for each line.
- valueFormat
  Specify an sprintf style format string used to display the reading values. If the format string is undef this reading will be skipped. Can be given as a string, a perl expression returning a hash or a perl expression returning a string, e.g.:
  `attr history valueFormat %.1f °C`
  `attr history valueFormat { temperature => "%.1f °C", humidity => "%.1f %" }`
  `attr history valueFormat { ($READING eq 'temperature')?"%.1f °C":undef }`
- rows
  Number of history rows to show.

### readingsProxy

Makes (a subset of) a reading from one device available as a new device.
This can be used to map channels from 1-Wire, EnOcean or SWAP devices to independend devices that can have state,icons and webCmd different from the parent device and can be used in a floorplan.
Define

`define <name> readingsProxy <device>:<reading>`
Examples:

`define myProxy readingsProxy myDS2406:latch.A`

Set

Get

Attributes

- disable
  1 -> disable notify processing. Notice: this also disables rename and delete handling.
- getList
  Space separated list of commands, which will be returned upon "get name ?", so the FHEMWEB frontend can construct a dropdown. %PARENT% will result in the complete list of commands from the parent device. get commands not in this list will be rejected.
- setList
  Space separated list of commands, which will be returned upon "set name ?", so the FHEMWEB frontend can construct a dropdown and offer on/off switches. %PARENT% will result in the complete list of commands from the parent device. set commands not in this list will be rejected. Example: attr proxyName setList on off
- readingFnAttributes
- getFn
  perl expresion that will return the get command forwarded to the parent device. has access to $DEVICE, $READING, $CMD and $ARGS.
  undef -> do nothing
  "" -> pass-through
  (<value>,1) -> directly return <value>, don't call parent getFn
  everything else -> use this instead
- setFn
  perl expresion that will return the set command forwarded to the parent device. has access to $CMD, $DEVICE, $READING and $ARGS.
  undef -> do nothing
  "" -> pass-through
  everything else -> use this instead
  Examples:
  `attr myProxy setFn {($CMD eq "on")?"off":"on"}`
- valueFn
  perl expresion that will return the value that sould be used as state. has access to $LASTCMD, $DEVICE, $READING and $VALUE.
  undef -> do nothing
  "" -> pass-through
  everything else -> use this instead
  Examples:
  `attr myProxy valueFn {($VALUE == 0)?"off":"on"}`
- perlSyntaxCheck

### remotecontrol

Displays a graphical remote control. Buttons (=icons) can be chosen and arranged. Predefined layouts are available for e.g. Samsung-TV or iTunes. Any buttonclick can be forwarded to the actual fhem-device. For further explanation, please check the Wiki-Entry.
Define

`define <rc-name> remotecontrol`
Typical steps to implement a remotecontrol:

`define rc1 remotecontrol` | `# defines a "blank" remotecontrol`
`get rc1 layout` | `# displays all available predefined layouts`
`set rc1 layout samsung` | `# assigns keys for a SamsungTV`
`set rc1 makenotify myTV` | `# creates notify_rc1 which forwards every buttonclick to myTV for execution`
Note: keys can be changed at any time, it is not necessary to redefine the weblink
`attr rc1 row15 VOLUP,VOLDOWN`

Set

- `set <rc-name> layout [delete|<layoutname>]`
  `layout delete` deletes all rowXX-attributes
  `layout <layoutname>` assigns a predefined layout to rowXX-attributes
- `set <rc-name> makeweblink [<name>]`
  creates a weblink to display the graphical remotecontrol. Default-name is weblink_<rc-name> .
- `set <rc-name> makenotify <executingDevice>`
  creates a notify to trigger <executingDevice> every time a button has been pressed. name is notify_<rc-name> .

Get

`get <rc-name> [htmlcode|layout]`
- `htmlcode` displays htmlcode for the remotecontrol on fhem-page
- `layout` shows which predefined layouts ae available

Attributes

- loglevel
- rc_iconpath
  path for icons, default is "icons" . The attribute-value will be used for all icon-files except .svg .
- rc_iconprefix
  prefix for icon-files, default is "" . The attribute-value will be used for all icon-files except .svg .
- Note: Icon-names (button-image-file-names) will be composed as `fhem/<rc_iconpath>/<rc_iconprefix><command|image>`
  For .svg -icons, the access sequence is according to the FHEMWEB-attribute iconPath, default is openautomation:fhemSVG:default .
- rc_devStateIcon
  In FHEMWEB-room-overview, displays the button-layout on the rc-device itself. Default is 1, set to 0 is the remotecontrol-device should not display its buttons in FHEMWEB roomview.
- rowXX
  `attr <rc-name> rowXX <command>[:<image>][,<command>[:<image>]][,...]`
  Comma-separated list of buttons/images per row. Any number of buttons can be placed in one row. For each button, use

- `<command>` is the command that will trigger the event after a buttonclick. Case sensitive.
- `<image>` is the filename of the image
- Per button for the remotecontrol, use
- `<command>` where an icon with the name <rc_iconprefix><command> is displayed
  Example:
  `attr rc1 rc_iconprefix black_btn_ # used for ALL icons on remotecontrol rc1`
  `attr rc1 row00 VOLUP`
  icon is `black_btn_VOLUP`, a buttonclick creates the event `VOLUP`
or
- `<command>:<image>` where an icon with the name `<rc_iconprefix><image>` is displayed
  Example:
  `row00=LOUDER:VOLUP`
  icon is `black_btn_VOLUP`, a buttonclick creates the event `LOUDER`
  Examples:
  `attr rc1 row00 1,2,3,TV,HDMI`
  `attr rc2 row00 play:PLAY,pause:PAUSE,louder:VOLUP,quieter:VOLDOWN`
- Hint: use :blank for a blank space, use e.g. :blank,:blank,:blank for a blank row

### restore

`restore list [<filename|directory>]
restore [<filename|directory>]
restore -a [<filename|directory>]`
Restore the files saved previously by the update command. Check the available files with the list argument. See also the update command and its restoreDirs attribute. After a restore normally a "shutdown restart" is necessary.
If the -a option is specified, the configuration files are also restored.

### rssFeed

This device helps to extract data from an rss feed specified by the url given in the DEF section. Trhe results will be extracted to several corresponding readings. Also the headlines of the news elements will be extracted to a special "ticker"-string that could be retrieved via GET or a special function. The data will be updated automatically after the given interval.
Define

`define <name> rssFeed <url> [interval]`

url = url of the rss feed

interval = actualization interval in seconds
Minimum for this value is 600 and maximum is 86400

Example:

`define rssGEA rssFeed http://www.gea.de/rss?cat=Region%20Reutlingen&main=true 3600`
The example will retrieve the data from the rss feed every hour

Set

`set <name> update`
retrieving the data from feed and updateing readings data

Get

`get <name> ticker`
getting the headlines from the feed with specified formatting (also see attributes)

Attributes

- disable
  This attribute can be used to disable the entier feed device (1) or to activate it again (0 or attribute missing). If the device is disabled all readings will be removed, except the state reading which will then be set to "disabled". Data will no longer be automatically retrieved from the url. The ticker data contains only one line indicating the disabled ticker device. (s.a. attribute rfDisabledText).
- rfDisabledText
  The text in this attribute will be returnde by GET ticker when the device is disabled (s.a. attribute disable). If this attribute is not specified a default text is returned.
  Example: `attr <name> rfDisabledText This feed is disabled`
- rfTickerChars
  Specifies a string which will surround each headline in the ticker data.
  Example: `attr <name> rfTickerChars +++`
  Result: `+++ This is a sample headline +++`
  These characters are also used for "marquee"-ticker data.
- rfMaxLines
  Defines the maximum number of news items that will be extracted from the feed. If there are less items in the feed then specified by this attribute then only that few items are extracted. If this attribute is missing a default of 10 will be assumed.
  Example: `attr <name> rfMaxLines 15`
- rfDisplayTickerReadings
  If this attribute is set then there will be two additional readings containing the ticker data for "toast"-Tickers (same as rssFeedGetTicker()) and one containing the ticker data for "marquee"-tickers on a single line.
- rfEncode
  Defines an encoding which will be used for any text extracted from the feed that will be applied before setting the readings. Therefore the encode method of the Perl-core module Encode is used. If the attribute is missng then no encoding will be performed. Sometimes this is necessary when feeds contain wide characters that could sometimes lead to malfunction in FHEMWEB. Also the headlines data returned by rssFeedFunctions and get ticker are encoded using this method.
  This will be set to utf8 by default on first define
- rfReadings
  This attribute defines the readings that will be created from the extracted data. It is a comma separated list of the following values:
  - title = title section
    extract the title section of the feed and each news item to a corresponding reading
  - description = description section
    extract the description section of the feed and each news item to a corresponding reading
  - encodedContent = content:encoded section
    if present this contains a more detailed description
  - pubDate = Publication time of feed and of each news item will be extracted to a corresponding reading.
  - link = link url to the feed or to the full article of a single news items in the feed.
  - buildDate = time of the last feed actulization by the feed vendor.
  - imageURl = url of a probably available image of a news item
  - imageTitle = image title of a probably available news item image.
  If this attribute is missing "title,description,pubDate" will be assumed as default value. When the device is defined for the first time the attribute will be automatically created with the default value.
- rfCustomTextPrepFn
  Can specify a funtion located for example in 99_myUtils.pm This function will be uses for further modification of extracted feed data before setting it to the readings or the ticker list. The function will receive an id for the text type and the text itself. It must then return the modified Text.
  Possible text type ids are (s.a. rfReadings)
  - feedTitle
  - feedDescription
  - imageTitle
  - desctiption
  - encodedContent
  Example for 99_myUtils.pm:

      #Text preparation for rssFeedDevices
      sub rssFeedPrep($$)
      {
      	my($texttype,$text) = @_;

      	#Cut the lenght of description texts to max 50 characters
      	my $tLn=length $text;
      	$text=substr($text,0,47).'...' if ($tLn >50 && ($texttype=~/description/));

      	#filter Probably errorneous HASH(xxxxxx) from any texts
      	return ' ' if ($text=~/HASH\(.*\)/);

      	#set a custom feed title reading
      	return 'My Special Title' if ($texttype =~/feedTitle/);

      	#returning modified text
      	return $text;
      }

  and then set the attribute to that function:
  `attr <rssFeedDevice> rfCustomTextPrepFn rssFeedPrep`
- rfAllReadingsEvents
  If this attribute is set to 1 all Readings that are created or updated will generate appropriate events (depending on event-on-... attributes). By default no events are created for most Readings, especially not for the feed data Readings
- readingFnAttributes

Functions

- rssFeedGetTicker
  This function will returned the foratted headlines as a single string. Each headline will be separated by a new line character. The result of this function can for example be used in InfoPanel as ticker data. The function takes the name of a rssFeed device as single parameter. The result is the same as from `get ticker` as it uses this function too. Syntax: `rssFeedGetTicker(<rssFeedDevice>)`

Readings

Depending on the attribute rfReadings a bunch of readings is created from the extracted news feed data. Some of the readings ar prefixed to tell to which part of the feed the data belongs to.

- `Nxx_`
  readings with that prefix correspond to the news items in the feed. `xx` index of the news item
  Example showing the readings of a single news item
  `N00_title`
  `N00_descripton`
  `N00_pubDate`
- `f_`
  redings with that prefix correspond to the feed itself.
  Example of feed-readings:
  `f_title`
  `f_descripton`
  `f_buildDate`
- `preparedLines`
  This readings contains the number of new items that were extracted in the last update of the feed data.
- `tickerToast`
  This reading contains the same data that is returned by the rssFeedGetTicker() funciton (if attribute rfDisplayTickerReadings is set)
  Example: `+++ Headline 1 +++ \n +++ Headline 2 +++ \n +++ Headline 3 +++`
- `tickerMarquee`
  This reading contains the ticker data on a single line for "marquee" style tickers (if attribute rfDisplayTickerReadings is set)
  Example: `Headline 1 +++ Hadline 2 +++ Headline 3 +++`
- `gzippedFeed`
  Sometimes RSS-Feed data is delivered gzipped. This is automatically recognized by the module. So if the received data was originally gzipped this reading is set to 1 otherwise it is set to 0
- `state`
  The state reading contains the timestamp of the last automatic or manual update of the device data from the feed, as long as the device is not disabled. If the device is disabled state contains "disabled". When the device is defined then the start of cyclic updates is retarded for about 10 seconds. During that time state is set to "defined"

### sequence

Define

`define <name> sequence <re1> <timeout1> <re2> [<timeout2> <re3> ...]`
A sequence is used to allow to trigger events for a certain combination of button presses on a remote. E.g. to switch on a lamp when pressing the Btn1:on, then Btn2:off and at last Btn1:on one after the other you could define the following:

`define lampseq sequence Btn1:on 0.5 Btn2:off 0.5 Btn1:on
define lampon notify lampseq:trigger set lamp on`

Set

N/A

Get

N/A

Attributes

- disable
- showtime
- triggerPartial
  if set (to 1), and not all the events of a sequence are received, then a partial_X event is generated by the sequence. Example:
  `
  fhem> define seq sequence d1:on 1 d1:on 1 d1:on
  fhem> attr seq triggerPartial
  fhem> set d1 on;; sleep 0.5;; set d1 on
  ` generates the event seq partial_2. This can be used to assign different tasks for a single button, depending on the number of times it is pressed.
- reportEvents
  if set (to 1), report the events (space separated) after the "trigger" or "partial_X" keyword. This way one can create more general sequences, and create different notifies to react:
  `define seq sequence remote:btn.* remote:btn.*
  attr seq reportEvents
  define n_b1b2 notify seq:trigger.remote:btn1.remote:btn2 set lamp1 on
  define n_b2b1 notify seq:trigger.remote:btn2.remote:btn1 set lamp1 off
  `

### siri

Module to control the FHEM/Siri integration.
Notes:

Attr

- siriName
  The name to use for a device with siri.

### speedtest

Provides internet speed data via speedtest-cli.
Notes:

- speedtest-cli hast to be installed on the FHEM host.

Define

`define <name> speedtest [<interval> [<server>]]`
Defines a speedtest device.
The data is updated every <interval> seconds. The default is 3600 and the minimum is 1800.
<server> gives the speedtest sever id. the list of all servers is available with

    speedtest-cli --list

. Examples:

`define speedtest speedtest`
`define speedtest speedtest 3600 2760`

Readings

- ping
- download
- upload

Set

- statusRequest
  manualy start a test. this works even if the device is set to disable.

Attributes

- path
  The path to the speedtest binary.
- checks-till-disable
  how often the speedtest should be run before it is automaticaly set to disabled. the value will be decreased by 1 for every run.
- disable
  set to 1 to disable the test.

=item helper =item summary Calculates for statistical values and adds them to the devices. =item summary_DE Berechnet statistische Werte und fügt sie dem Gerät hinzu.

### statistics

(en | de)

This modul calculates for certain readings of given devices statistical values and adds them to the devices.
For detail instructions, look at and please maintain the FHEM-Wiki.
Until now statistics for the following readings are automatically built:

- Min|Avg|Max Minimum, average and maximum of instantaneous values:
  over a period of day, month and year:
  brightness, current, energy_current, humidity, luminosity, temperature, voltage
  over a period of hour, day, month and year:
  wind, wind_speed, windSpeed
- Tendency over 1h, 2h, 3h und 6h: pressure
- Delta between start and end values - over a period of hour, day, month and year:
  count, energy, energy_total, power, total, rain, rain_rate, rain_total
- Duration (and counter) of the states (on, off, open, closed...) over a period of day, month and year:
  lightsensor, lock, motion, Window, window, state (if no other reading is recognized)

Further readings can be added via the attributes `deltaReadings, durationReadings, minAvgMaxReadings, tendencyReadings`. This allows also to assign a reading to another statistic type.
Define

`define <name> statistics <deviceNameRegExp> [Prefix]`
Example: `define Statistik statistics Sensor_.*|Wettersensor`
- `<DeviceNameRegExp>`
  Regular expression of device names. !!! Not the device readings !!!
- `[Prefix]`
  Optional. Prefix set is place before statistical data. Default is stat

Set

- `resetStatistics <All|DeviceName>`
  Resets the statistic values of the selected device.
- `doStatistics`
  Calculates the current statistic values of all monitored devices.

Get

not implemented yet

Attributes

- `dayChangeTime <time>`
  Time of day change. Default is 00:00. For weather data the day change can be set e.g. to 06:50.
- `deltaReadings <readings>`
  Comma separated list of reading names for which a delta statistic shall be calculated.
- `durationPeriodHour < 1 | 0 >`
  If set to 1, then duration readings will get hourly statistics too.
- `durationReadings <readings>`
  Comma separated list of reading names for which a duration statistic shall be calculated.
- `excludedReadings <DeviceRegExp:ReadingNameRegExp>`
  Regular expression of the readings that shall be excluded from the statistics.
  The reading have to be entered in the form deviceName:readingName.
  E.g. `FritzDect:current|Sensor_.*:humidity`
- `ignoreDefaultAssignments `< 0 | 1 >``
  Ignores the default assignments of readings to a statistic type (see above).
  So, only the readings that are listed in the specific attributes are evaluated.
- `minAvgMaxReadings <readings>`
  Comma separated list of reading names for which a min/average/max statistic shall be calculated.
- `periodChangePreset <seconds>`
  Preponed start of the calculation of periodical data. Default is 5 second before each full hour.
  Allows thus the correct timely assignment within plots. Should be adapted to the CPU speed or load of the server.
- `singularReadings <DeviceRegExp:ReadingRegExp>:statTypes:period`
  - statTypes: Min|Avg|Max|Delta|DurationState|Tendency
  - period: Hour|Day|Month|Year|1h|2h|3h|6h
  Regulare expression of statistic values, which for which singular readings are created additionally to the summary readings. Eases the creation of plots. For duration readings the name of the state has to be used as statTypes.
  Example:
    `Wettersensor:rain:Delta:(Hour|Day)|(FritzDect:(current|power):(Avg|Max|Delta):(Hour|Day)`
    `Badfenster:Window:(Open|Open_Count):Month`
- `specialDeltaPeriods <Device:Reading:Period:count1:count2:...>`
  Creates for the given delta reading additional singular readings of the given numbers of a period (Hour, Day, Month)
  Regular expressions cannot be used. Additional readings or additional periods can be defined but have to be separated by a comma (without spaces).
  Example:
    `attr Statistik specialDeltaPeriods Wettersensor:rain:Hour:06:72:96`
    This will create 3 additional readings for the rain of the last 6, 72 and 96 hours.
    `attr Statistik specialDeltaPeriods Wettersensor:rain:Hour:48,Wettersensor:rain:Day:30,EZaehler:energy:Month:6:12`
    This will create 4 additional readings for the rain of the last 48 hours and the last 30 Days and the energy consumtion of the last 6 and 12 months.
- `specialDeltaPeriodHours`
  depreciated
- `tendencyReadings <readings>`
  Comma separated list of reading names for which a tendendy statistic shall be calculated.

### structure

Define

`define <name> structure <struct_type> <dev1> <dev2> ...`
The structure device is used to organize/structure devices in order to set groups of them at once (e.g. switching everything off in a house).
The list of attached devices can be modified through the addstruct / delstruct commands. Each attached device will get the attribute <struct_type>=<name>
when it is added to the list, and the attribute will be deleted if the device is deleted from the structure.
The structure devices can also be added to a structure, e.g. you can have a building consisting of levels which consists of rooms of devices.
Example:

- define kitchen structure room lamp1 lamp2
- addstruct kitchen TYPE=FS20
- delstruct kitchen lamp1
- define house structure building kitchen living
- set house off

Set

Every set command is propagated to the attached devices. Exception: if an attached device has an attribute structexclude, and the attribute value matches (as a regexp) the name of the current structure.
If the set is of the form `set <structure> [FILTER=<filter>] <type-specific>` then :FILTER=<filter> will be appended to the device name in the propagated set for the attached devices like this: `set <devN>:FILTER=<filter> <type-specific>`

Get

get is not supported through a structure device.

Attributes

- async_delay
  If this attribute is defined, unfiltered set commands will not be executed in the clients immediately. Instead, they are added to a queue to be executed later. The set command returns immediately, whereas the clients will be set timer-driven, one at a time. The delay between two timercalls is given by the value of async_delay (in seconds) and may be 0 for fastest possible execution. This way, excessive delays often known from large structures, can be broken down in smaller junks.
- disable
- disabledForIntervals
- clientstate_behavior
  The backward propagated status change from the devices to this structure works in two different ways.
  - absolute
    The structure status will changed to the common device status of all defined devices to this structure if all devices are identical. Otherwise the structure status is "undefined".
  - relative
    See below for clientstate_priority.
  - relativeKnown
    Like relative, but do not trigger on events not described in clientstate_priority. Needed e.g. for HomeMatic devices.
  - last
    The structure state corresponds to the state of the device last changed.
- clientstate_priority
  If clientstate_behavior is set to relative, then you have to set the attribute "clientstate_priority" with all states of the defined devices to this structure in descending order. Each group is delemited by space or /. Each entry of one group is delimited by "pipe". The status represented by the structure is the first entry of each group. Example:
  - attr kitchen clientstate_behavior relative
  - attr kitchen clientstate_priority An|On|on Aus|Off|off
  - attr house clientstate_priority Any_On|An All_Off|Aus
  In this example the status of kitchen is either on or off. The status of house is either Any_on or All_off.
- <struct_type>_map
  With this attribute, which has to specified for the structure- member, you can redefine the value reported by a specific structure-member for the structure value. The attribute has three variants:
  - readingName
    take the value from readingName instead of state.
  - oldVal:newVal
    if the state reading matches oldVal, then replace it with newVal
  - readingName:oldVal:newVal
    if readingName matches oldVal, then replace it with newVal
  Example:
  - define door OWSWITCH <ROMID>
  - define lamp1 dummy
  - attr lamp1 cmdlist on off
  - define kitchen structure struct_kitchen lamp1 door
  - attr kitchen clientstate_priority An|on OK|Aus|off
  - attr lamp1 struct_kitchen_map on:An off:Aus
  - attr door struct_kitchen_map A:open:on A:closed:off
  - attr door2 struct_kitchen_map A
- structexclude
  exclude the device from set/notify or attribute operations. For the set and notify the value of structexclude must match the structure name, for the attr/deleteattr commands ist must match the combination of structure_name:attribute_name. Examples:
  `define kitchen structure room lamp1 lamp2
  attr lamp1 structexclude kitchen
  attr lamp1 structexclude kitchen:stateFormat
  `
- readingFnAttributes

### tahoma

The module realizes the communication with io-homecontrol® Devices e.g. from Somfy® or Velux®
A registered TaHoma® Connect gateway from Overkiz® sold by Somfy® which is continously connected to the internet is necessary for the module.
Notes:

- JSON has to be installed on the FHEM host.
- on problems refer also the fhem forum IO-Homecontrol Devices über Tahoma Box einbinden

Define

`define <name> tahoma ACCOUNT <username> <password>`
`define <name> tahoma DEVICE <DeviceURL>`
`define <name> tahoma PLACE <oid>`
`define <name> tahoma SCENE <oid>`
A definition is only necessary for a tahoma device:
`define <name> tahoma ACCOUNT <username> <password>`
If a tahoma device of the type ACCOUNT is created, all other devices acessable by the tahoma gateway are automaticaly created!
If the account is valid, the setup will be read from the server.
All registrated devices are automatically created with name tahoma_12345 (device number 12345 is used from setup)
All defined rooms will be are automatically created.
Also all defined scenes will be automatically created.
global Attributes for ACCOUNT:

If autocreate is disabled, no devices, places and scenes will be created automatically:
`attr autocreate disable`

local Attributes for ACCOUNT:

Normally, the web commands will be send asynchron, and this can be forced to wait of the result by blocking=1
`attr tahoma1 blocking 1`

local Attributes for DEVICE:

If the closure value 0..100 should be 100..0, the level can be inverted:
`attr tahoma_23234545 levelInvert 1`

local Attributes for PLACE:

The commands in a room will only affect the devices in the room with inClass=RollerShutter.
This can be extend or changed by setting the placeClasses attribut:
`attr tahoma_abc12345 placeClasses RollerShutter ExteriorScreen Window`

Examples:

`define tahoma1 tahoma ACCOUNT abc@test.com myPassword`
`attr tahoma1 blocking 0`
`attr tahoma1 room tahoma`
Automatic created device e.g.:
`define tahoma_23234545 tahoma DEVICE io://0234-5678-9012/23234545`
`attr tahoma_23234545 IODev tahoma1`
`attr tahoma_23234545 alias RollerShutter Badezimmer`
`attr tahoma_23234545 room tahoma`
`attr tahoma_23234545 webCmd dim`
Automatic created place e.g.:
`define tahoma_abc12345 tahoma PLACE abc12345-0a23-0b45-0c67-d5e6f7a1b2c3`
`attr tahoma_abc12345 IODev tahoma1`
`attr tahoma_abc12345 alias room Wohnzimmer`
`attr tahoma_abc12345 room tahoma`
Automatic created scene e.g.:
`define tahoma_4ef30a23 tahoma SCENE 4ef30a23-0b45-0c67-d5e6-f7a1b2c32e3f`
`attr tahoma_4ef30a23 IODev tahoma1`
`attr tahoma_4ef30a23 alias scene Rolladen Südfenster zu`
`attr tahoma_4ef30a23 room tahoma`

### telnet

Define

`define <name> telnet <portNumber> [global|hostname]`
or
`define <name> telnet <servername>:<portNumber>`
First form, server mode:
Listen on the TCP/IP port `<portNumber>` for incoming connections. If the second parameter is not specified, the server will only listen to localhost connections. If the second parameter is global, telnet will listen on all interfaces, else it wil try to resolve the parameter as a hostname, and listen only on this interface.
To use IPV6, specify the portNumber as IPV6:<number>, in this case the perl module IO::Socket:INET6 will be requested. On Linux you may have to install it with cpan -i IO::Socket::INET6 or apt-get libio-socket-inet6-perl; OSX and the FritzBox-7390 perl already has this module.
Examples:

`define tPort telnet 7072 global`
`attr tPort SSL`
`attr allowed_tPort allowed`
`attr allowed_tPort validFor tPort`
`attr allowed_tPort globalpassword mySecret`

Note: The old global attribute port is automatically converted to a telnet instance with the name telnetPort. The global allowfrom attibute is lost in this conversion.
Second form, client mode:
Connect to the specified server port, and execute commands received from there just like in server mode. This can be used to connect to a fhem instance sitting behind a firewall, when installing exceptions in the firewall is not desired or possible. Note: this client mode supprts SSL, but not IPV6.
Example:

Start tcptee first on publicly reachable host outside the firewall.

perl contrib/tcptee.pl --bidi 3000

Configure fhem inside the firewall:

define tClient telnet <tcptee_host>:3000

Connect to the fhem from outside of the firewall:

telnet <tcptee_host> 3000

Set

N/A

Get

N/A

Attributes:

- prompt
  Sets the string for the telnet prompt, the default is fhem>
- SSL
  Enable SSL encryption of the connection, see the description here on generating the needed SSL certificates. To connect to such a port use one of the following commands:
  socat openssl:fhemhost:fhemport,verify=0 readline
  ncat --ssl fhemhost fhemport
  openssl s_client -connect fhemhost:fhemport
- allowfrom
  Regexp of allowed ip-addresses or hostnames. If set, only connections from these addresses are allowed.
- connectTimeout
  Wait at maximum this many seconds for the connection to be established. Default is 2.
- connectInterval
  After closing a connection, or if a connection cannot be estblished, try to connect again after this many seconds. Default is 60.
- encoding
  Sets the encoding for the data send to the client. Possible values are latin1 and utf8. Default is utf8.
- sslVersion
  See the global attribute sslVersion.

### update

`update [<fileName>|all|check|force] [http://.../controlfile]`
or
`update [add source|delete source|list|reset]`
Update the FHEM installation. Technically this means update will download the controlfile(s) first, compare it to the local version of the file in the moddir/FHEM directory, and download each file where the attributes (timestamp and filelength) are different. Upon completion it triggers the global:UPDATE event.
With the commands add/delete/list/reset you can manage the list of controlfiles, e.g. for thirdparty packages. Notes:

- The contrib directory will not be updated.
- The files are automatically transferred from the source repository (SVN) to the web site once a day, at 7:45 CET / CEST.
- The all argument is default.
- The force argument will disregard the local file.
- The check argument will only display the files it would download, and the last section of the CHANGED file.
- Specifying a filename will only download matching files (regexp).

See also the restore command.
Examples:

- update check
- update
- update force
- update check http://fhem.de/fhemupdate/controls_fhem.txt

Attributes (use attr global ...)

- updateInBackground
  If this attribute is set (to 1), the update will be executed in a background process. The return message is communicated via events, and in telnet the inform command is activated, in FHEMWEB the Event Monitor. Default is set. Set it to 0 to switch it off.
- updateNoFileCheck
  If set, the command won't compare the local file size with the expected size. This attribute was introduced to satisfy some experienced FHEM user, its default value is 0.
- backup_before_update
  If this attribute is set, an update will back up your complete installation via the backup command. The default is not set as update relies on the restore feature (see below).
  Example:
  attr global backup_before_update
- exclude_from_update
  Contains a space separated list of fileNames (regexps) which will be excluded by an update. The special value commandref will disable calling commandref_join at the end, i.e commandref.html will be out of date. The module-only documentation is not affected and is up-to-date.
  Example:
  attr global exclude_from_update 21_OWTEMP.pm FS20.off.png
- restoreDirs
  update saves each file before overwriting it with the new version from the Web. For this purpose update creates a directory restoreDir 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. If the attribute is set to 0, the feature is deactivated.

### version

`version [<filter>|revision] [noheader]`
List the version of fhem.pl and all loaded modules. The optional parameter can be used to filter the ouput. The special filter value "revision" shows only the latest revision number since the last update.
The optional flag `noheader` disables the output of the header lines (Latest Revision, File, Rev, Last Change).
Example output of `version`:

`
Latest Revision: 10814
File Rev Last Change
fhem.pl 10769 2016-02-08 12:11:51Z rudolfkoenig
90_at.pm 10048 2015-11-29 14:51:40Z rudolfkoenig
98_autocreate.pm 10165 2015-12-13 11:14:15Z rudolfkoenig
00_CUL.pm 10146 2015-12-10 10:17:42Z rudolfkoenig
10_CUL_HM.pm 10411 2016-01-08 15:18:17Z martinp876
...`

Example output of `version fhem.pl`:

`
File Rev Last Change
fhem.pl 10397 2016-01-07 08:36:49Z rudolfkoenig
`

Example output of `version fhem.pl noheader`:

`
fhem.pl 10397 2016-01-07 08:36:49Z rudolfkoenig
`

### watchdog

Define

`define <name> watchdog <regexp1> <timespec> <regexp2> <command>`
Start an arbitrary FHEM command if after <timespec> receiving an event matching <regexp1> no event matching <regexp2> is received.
The syntax for <regexp1> and <regexp2> is the same as the regexp for notify.
<timespec> is HH:MM[:SS]
<command> is a usual fhem command like used in the at or notify
Examples: `

# Request data from the FHT80 _once_ if we do not receive any message for
# 15 Minutes.
define w watchdog FHT80 00:15:00 SAME set FHT80 date
# Request data from the FHT80 _each_ time we do not receive any message for
# 15 Minutes, i.e. reactivate the watchdog after it triggered. Might be
# dangerous, as it can trigger in a loop.
define w watchdog FHT80 00:15:00 SAME set FHT80 date;; trigger w .
# Shout once if the HMS100-FIT is not alive
define w watchdog HMS100-FIT 01:00:00 SAME "alarm-fit.sh"
# Send mail if the window is left open
define w watchdog contact1:open 00:15 contact1:closed "mail_me close window1"
attr w regexp1WontReactivate

` Notes:

- if <regexp1> is . (dot), then activate the watchdog at definition time. Else it will be activated when the first matching event is received.
- <regexp1> resets the timer of a running watchdog, to avoid it use the regexp1WontReactivate attribute.
- if <regexp2> is SAME, then it will be the same as the first regexp, and it will be reactivated, when it is received.
- trigger <watchdogname> . will activate the trigger if its state is defined, and set it into state defined if its state is active (Next:...) or triggered. You always have to reactivate the watchdog with this command once it has triggered (unless you restart fhem)
- a generic watchdog (one watchdog responsible for more devices) is currently not possible.
- with modify all parameters are optional, and will not be changed if not specified.

Set

- inactive
  Inactivates the current device. Note the slight difference to the disable attribute: using set inactive the state is automatically saved to the statefile on shutdown, there is no explicit save necesary.
  This command is intended to be used by scripts to temporarily deactivate the notify.
  The concurrent setting of the disable attribute is not recommended.
- active
  Activates the current device (see inactive).

Get

N/A

Attributes

- disable
- disabledForIntervals
- regexp1WontReactivate
  When a watchdog is active, a second event matching regexp1 will normally reset the timeout. Set this attribute to prevents this.
- execOnActivate If set, its value will be executed as a FHEM command when the watchdog is reactivated (after triggering) by receiving an event matching regexp1.
- autoRestart When the watchdog has triggered it will be automatically re-set to state defined again (waiting for regexp1) if this attribute is set to 1.

### weblink

Define

`define <name> weblink [link|image|iframe|htmlCode|cmdList] <argument>`
This is a placeholder device used with FHEMWEB to be able to add user defined links. Examples:

`define homepage weblink link http://www.fhem.de
define webcam_picture weblink image http://w.x.y.z/current.jpg
define interactive_webcam weblink iframe http://w.x.y.z/webcam.cgi
define hr weblink htmlCode <hr>
define w_Frlink weblink htmlCode { WeatherAsHtml("w_Frankfurt") }
define systemCommands weblink cmdList pair:Pair:set+cul2+hmPairForSec+60 restart:Restart:shutdown+restart update:UpdateCheck:update+check`

Notes:

- For cmdList <argument> consists of a list of space separated icon:label:cmd triples.

Set

N/A

Get

N/A

Attributes

- htmlattr
  HTML attributes to be used for link, image and iframe type of links. E.g.:
  `define yw weblink iframe http://weather.yahooapis.com/forecastrss?w=650272&u=c
  attr yw htmlattr width="480" height="560"
  `
- nodetaillink
  Show no detail link for the types image and iframe.
- disable
- disabledForIntervals

### weekprofile

With this module you can manage and edit different weekprofiles. You can send the profiles to different devices.
Currently the following devices will by supported:
- MAX
- other weekprofile modules
- Homatic channel _Clima or _Climate
In the normal case the module is assoziated with a master device. So a profile 'master' will be created automatically. This profile corrensponds to the current active profile on the master device. You can also use this module without a master device. In this case a default profile will be created.
An other use case is the usage of categories 'Topics'. To enable the feature the attribute 'useTopics' have to be set. Topics are e.q. winter, summer, holidays, party, and so on. A topic consists of different week profiles. Normally one profile for each thermostat. The connection between the thermostats and the profile is an user attribute 'weekprofile' without the topic name. With 'restore_topic' the defined profile in the attribute will be transfered to the thermostat. So it is possible to change the topic easily and all thermostats will be updated with the correndponding profile.
Attention: To transfer a profile to a device it needs a lot of Credits. This is not taken into account from this module. So it could be happend that the profile in the module and on the device are not equal until the whole profile is transfered completly.
If the maste device is Homatic HM-TC-IT-WM-W-EU then only the first profile (R_P1_...) will be used!
For this module libjson-perl have to be installed
Events:
Currently the following event will be created:
- PROFILE_TRANSFERED: if a profile or a part of a profile (changes) is send to a device
- PROFILES_SAVED: the profile are stored in the config file (also if there are no changes)
Define

`define <name> weekprofile [master device]`
Activate the module with or without an assoziated master device. The master device is an optional parameter. With a master device a spezial profile 'master' will be created.
Special master' profile handling:
- Can't be deleted
- Will be automatically transfered to the master device if it was modified
- Will not be saved
Without a master device a 'default' profile will be created

Set

- profile_data
  `set <name> profile_data <profilename> <json data>`
  The profile 'profilename' will be changed. The data have to be in json format.
- send_to_device
  `set <name> send_to_device <profilename> [devices]`
  The profile 'profilename' will be transfered to one or more the devices. Without the parameter device the profile will be transferd to the master device. 'devices' is a comma seperated list of device names
- copy_profile
  `set <name> copy_profile <source> <destination>`
  Copy from source to destination. The destination will be overwritten
- remove_profile
  `set <name> remove_profile <profilename>`
  Delete profile 'profilename'.
- reference_profile
  `set <name> reference_profile <source> <destination>`
  Create a reference from destination to source. The destination will be overwritten if it exits.
- restore_topic
  `set <name> restore_topic <topic>`
  All weekprofiles from the topic will be transfered to the correcponding devices. Therefore a user attribute 'weekprofile' with the weekprofile name without the topic name have to exist in the device.

Get

- profile_data
  `get <name> profile_data <profilename>`
  Get the profile data from 'profilename' in json-Format
- profile_names
  `set <name> profile_names [topicname]`
  Get a comma seperated list of weekprofile profile names from the topic 'topicname' If topicname is not set, 'default' will be used If topicname is '*', all weekprofile profile names are returned.
- profile_references [name]
  If name is '*', a comma seperated list of all references in the following syntax `ref_topic:ref_profile>dest_topic:dest_profile` are returned If name is 'topicname:profilename', '0' or the reference name is returned.
- topic_names
  Return a comma seperated list of topic names.

Readings

- active_topic
  Active\last restored topic name
- profile_count
  Count of all profiles including references.

Attributes

- widgetWeekdays
  Comma seperated list of week days starting at Monday `attr name widgetWeekdays Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday`
- widgetEditOnNewPage
  Editing the profile on a new html page if it is set to '1'
- widgetEditDaysInRow
  Count of visible days in on row during Edit. Default 2.
- configFile
  Path and filename of the configuration file where the profiles will be stored Default: ./log/weekprofile-<name>.cfg
- icon
  icon for edit
  Default: edit_settings
- useTopics
  Enable topics.
  Default: 0
- tempON
  Temperature for 'on'. e.g. 30
- tempOFF
  Temperature for 'off'. e.g. 4

### withings

xxx
Notes:

- JSON, LWP::Simple and Digest::MD5 have to be installed on the FHEM host.

Define

`define <name> withings <device>`
`define <name> withings <userid> <publickey>`
`define <name> withings [ACCOUNT] <login> <password>`
Defines a withings device.
If a withings device of the account type is created all fhem devices for users and devices are automaticaly created.
Examples:

`define withings withings abc@test.com myPassword`
`define withings withings 642123 2a42f132b9312311`

Readings

- weight
- height
- fatFreeMass
- fatRatio
- fatMass
- diastolicBloodPressure
- systolicBloodPressure
- heartPulse
- co2
- battery
- batteryLevel

Get

- update
  trigger an update

Attributes

- interval
  the interval in seconds used to check for new values.
- disable
  1 -> stop polling

### xxLG7000

Define

`define <name> xxLG7000 <serial-device>`
Defines a serial link to a TV set of LG's xxLG70yy (e. g. 47LG7000) series and similar TV sets from LG. As of January 2010, the following TV sets should be compatible:

- `xxLG7000`, e. g. 47LG7000 (tested)
- `xxPG7000`, e. g. 50PG7000 (same Manual as 47LG7000 ;))
- `PS3000/6000/7000/8000 series` (according to LG brochure; no liabilities assumed)
- `PQ3000/6000 series` (see PS3000)
- `LU4000/5000 series` (not LU7000; see PS3000)
- `LH2000/3000/4000/5000 series` (see PS3000)
- `SL9500/9000/8000 series` (see PS3000)

These TV sets feature a serial connector which can officially be used to control the TV set (see your Onwer's Manual, there's an Appendix labelled "External Control Device setup", referening to cabling and command set). The xxLG7000 module is the FHEM module to actually utilize this. (BTW, those TVs run Linux internally ;))
To exercise control over your TV set, use the LGTV module and bind it ("attr <LGTV-name> IODev <xxLG7000-name>") to xxLG7000.
Examples:

`define myLG7k xxLG7000 /dev/ttyUSB1`

Set

Not used, nothing to set directly.

Get

Not used, nothing to get directly.

Attributes

- loglevel
- SetID (1, 2, ...; see your TV's Owner's Manual how to set it. Defaults to 1 if unset.)

### yowsup

Module to interface to the yowsup library to send and recive WhatsApp messages.
Notes:

- Probably only works on linux/unix systems.

Define

`define <name> yowsup`
Defines a yowsup device.
Examples:

`define WhatsApp yowsup`

Set

- image [<number>] <path> [<text>]
  sends an image with optional text. <number> has to be given if sending via master device.
- send [<numner>] <text>
  sends <text>. <number> has to be given if sending via master device.

Attributes

- cmd
  complette commandline to start the yowsup cli client
  eg: attr WhatsApp cmd /opt/local/bin/yowsup-cli demos -c /root/config.yowsup --yowsup
- home
  set $HOME for the started yowsup process
  PWD -> set to $PWD
  anything else -> use as $HOME
- nickname
  nickname that will be send as sender
- acceptFrom
  comma separated list of contacts (numbers) from which messages will be accepted
- commandPrefix
  not set -> don't accept commands
  0 -> don't accept commands
  1 -> allow commands, every message is interpreted as a fhem command
  anything else -> if the message starts with this prefix then everything after the prefix is taken as the command
- allowedCommands
  A comma separated list of commands that are allowed from this contact.
  If set to an empty list `, (i.e. comma only)` no commands are accepted.
  Note: allowedCommands should work as intended, but no guarantee can be given that there is no way to circumvent it.

### Perl specials

If you want to automate some tasks via FHEM, then you'll probably use at or notify. For more complex tasks you'll use either a shell-script or a perl "oneliner" as the at/notify argument. This chapter gives some tips in using the perl oneliners.
- To test the following perl oneliners, type them on the telnet prompt (or FHEMWEB text input) by enclosing it in {}, one line at once. The last line will only write something in the logfile, the output of the other lines is directly visible.
  { "Hello" }
  { 1+3*4 }
  { `ls /etc` }
  { Log 1, "Hello" }
- Perl expressions are separated by ;, in FHEM oneliners they have to escaped with ;;
  { my $a = 1+1;; Log 1, "Hello $a" }
- To use FHEM commands from the perl expression, use the function fhem(), which takes a string argument, this string will be evaluated as a FHEM command:
  { fhem "set light on" }
  define n1 notify piri:on { fhem "set light on" }
  Note: if this function returns a value, it will also be logged into the global FHEM log. Use 1 as a second argument to disable this logging, this makes sense when obtainig some values via FHEM "get...".
- Notify can be used to store macros for manual execution. Use the trigger command to execute the macro:
  define MyMacro notify MyMacro { Log 1, "Hello"}
  trigger MyMacro
  define MacroWithArg notify MyMacro { Log 1, "Hello %"}
  trigger MyMacro MyArg
- To make date and time handling easier, the variables $sec, $min, $hour, $mday, $month, $year, $wday, $yday, $isdst are available in the perl oneliners (see also perldoc -f localtime). Exceptions: $month is in the range of 1 to 12, and $year is corrected by 1900 (as I would expect). Additionally the variable $hms contains the time in the HH:MM:SS format.
  Additionally the variabe $we is 1 if it is weekend (i.e $wday == 0 or $wday == 6), and 0 otherwise. If the holida2we global attribute is set, $we is 1 for holidays too.
  define n2 notify piri:on { if($hour > 18 || $hour < 5) { fhem "set light on" } }
  define roll_en *07:45:00 { fhem "trigger SwitchAllRoll on" if(!$we) }
  define roll_en *08:30:00 { fhem "trigger SwitchAllRoll on" if($we) }
- The following helper functions are defined in 99_Util.pm (which will be loaded automatically, as every module with prefix 99):
  - min(a,b), max(a,b)
  - time_str2num("YYYY-MM-DD HH:MM:SS") returns a numerical value, which makes computation of time differences easier
  - abstime2rel("HH:MM:SS") converts an absolute time to a relative one
- To access the device states/attributes, use the following functions:
  - Value(<devicename>)
    returns the state of the device (the string you see in paranthesis in the output of the list command).
  - OldValue(<devicename>)
  - OldTimestamp(<devicename>)
    returns the old value/timestamp of the device.
  - ReadingsVal(<devicename>,<reading>,<defaultvalue>)
    Return the reading (the value in the Readings section of "list device")
  - ReadingsNum(<devicename>,<reading>,<defaultvalue>)
    Return the reading as a number, i.e. delete non-numerical values.
  - AttrVal(<devicename>,<attribute>,<defaultvalue>)
    Return the attribute of the device
    { Value("wz") }
    { OldValue("wz") }
    { time_str2num(OldTimestamp("wz")) }
    { ReadingsVal("wz", "measured-temp", "20")+0 }
    { ReadingsTimestamp("wz", "measured-temp", 0)}
    { AttrVal("wz", "room", "none") }
  - InternalVal(<devicename>,<property>,<defaultvalue>)
    Return the internal value (the value in the Internals section of "list device").
- By using the 99_SUNRISE_EL.pm module, you have access to the following functions:
  sunset($offset, $min, $max)
  sunrise($offset, $min, $max)
  isday()
  offset is in seconds, and the format of min/max is "HH:MM" or "HH:MM:SS". isday returns 1 if the sun is visible, and 0 else.

### gnuplot file syntax

The .gplot files are also used by the FHEMWEB/SVG module when the plotmode attribute is set to SVG. In this case only a subset of the .gnuplot attributes are used, and some lines have special meanings: the difference will be explained in this chapter. See also this FHEM Wiki entry on creating logs.
Following is a minimal .gplot definition (valid only for plotmode SVG):

      set terminal size <SIZE>
      #FileLog 4:::
      plot title 'Temperature' with lines

The .gnuplot file consists of 3 parts:

- set commands
  Following sets are recognized:
  - terminal, only the size parameter.
    This is usually set to <SIZE>, which is replaced by the plotsize attribute of the FHEMWEB or weblink instance.
  - title
    Usually set to <TL> which is replace by the weblink title attribute, or to <Lx>, which is replaced by the weblink label attribute.
  - ylabel,y2label
    Left and right labels, printed vertically. Are also subject to label replacement.
  - yrange,y2range
    Specify the range of the left and right axis. Examples:
    set yrange [-0.1:1.1]
    set y2range [0:]
  - ytics,y2tics
    the label for the left/right axis tics. Examples:
    set ytics ("on" 0, "off" 1)
    set y2tics
- #FileLog entries
  Each line from the plot section must have one corresponding #FileLog line. For the syntax see the column_spec paragraph of the Filelog get description. Note that for SVG plots the first column of the input file always has to be in the standard fhem timestamp format (YYYY-MM-DD_HH:MM:SS)
- plot entries
  There is always one plot command with comma separated argument-blocks. Each argument-block represents one line, and has its own parameters. Following parameters are recognized:
  - axes x1y1 / x1y2
    tells the program to assign the current line to one of the two axes (left or right).
  - title
    Caption of the line. Whan clicking on this title, a small javascript program will change the title to the min/max and last values of the plot, will enable copying this line or pasting an already copied one (the existing scale of the plot wont'be changed, only the pasted line will be scaled), and other lines of the plot will temporarily be hidden.
  - with <linetype>
    Specify the line type. Following types are recognized: points, steps, fsteps, histeps and lines. Everything unknown will be mapped to the type lines. SVG special: cubic and quadratic, are mapped to the SVG path types C, and Q respectively.
  - ls <linestyle>
    The linestyle defaults to l0 for the first line, l1 for the second, and so on. It is defined in the svg_style.css file. There are two sets defined here: l0-l8 and l0fill-l6fill. The second set must be specified explicitly. If the name of the linestyle contains the word fill, then plots of the lineytype "lines" will have an additional starting and ending segment, so that filling is done correctly.
    See the SVG spec for details of this CSS file. Note: if you plan to use this attribute, you have to specify it for all the lines (attribute-blocks) in the plot command.
  - lw <linewidth>
    Sets the stroke-width style of the line. This attribute is deprecated, the corresponding feature of the CSS file / (attribute ls) should be used instead.