fhem-mirror/fhem/UPGRADE

This file describes the changes to made in a FHEM installation when upgrading
_to_ the named version from an older version. It describes no new features,
only features not working anymore.  It may or may not work to set "attr global
featurelevel X.Y" (where X.Y is the old FHEM version, e.g. 5.6) in order to
enable the old feature.

- 2015-11-15 (5.7)
  - In the evaluated perl expression $value{DEVICE} is not set any more, use
    Value("DEVICE") instead
  - the lastinclude global attribute (as in attr global lastinclude filename)
    is not evaluated anymore, use the following instead:
      define lastinclude notify global:INITIALIZED include filename
  - In the evaluated perl expression % was replaced with the event, and @ with
    the device name. Instead of % $EVENT must be used, and instead of @ $NAME.
    The double %% and @@ is not replaced with a single % and @ anymore.

- 2017-02-19 (5.8)
  - the FHEMWEB csrfToken attribute is set to a random value on each startup,
    which is checked when executing a command started via the FHEMWEB HTTP
    connection. Something like:
      wget 'http://fhemhost:8083/fhem?cmd=set%20device%20on'
    wont work anymore. One solutions is to set "attr WEB csrfToken mySecret" and
    rewrite the above call to:
      wget 'http://fhemhost:8083/fhem?cmd=set%20device%20on&fwcsrf=mySecret'
    There are other solutions in the FHEM wiki.

- 2018-10-07 (5.9)
  - the default for the setStructType structure attribute changed from 1 to 0
  - the default for the style setting changed to f18, the old "default" is
    still present.
  - the default for the iconPath changed from default:fhemSVG:openautomation to 
    fhemSVG:openautomation:default. NOTE: the old version may be needed for
    FLORRPLAN users
  - the default fhem.cfg does not contain a telnet definition

- 2020-01-26 (6.0)
  - attribute names can only consist of the character A-Za-z/\d_\.-
  - 98_structure: propagateAttr defaults to empty and not to all => setting
    attributes on structure wont be set automatically on the members.

- 2021-11-07 (6.1) 
  - 98_RandomTimer: evaluate state reading instead of STATE (Value()).
    NOTE: In 6.0 version this can be forced by new attribute offState
  - 96_allowed: the default for allowedIfAuthenticatedByMe is now 1 (relevant
    if there are multiple allowed devices valid for the same target).
  - Deprecated modules (consider replacing them by named alternative(s) 
    prior to upgrading):
    10_MQTT_BRIDGE (=> MQTT_GENERIC_BRIDGE)
    98_Heating_Control (=> WeekdayTimer)
    10_EIB (=> 10_KNX)
    93_RFHEM (=> FHEM2FHEM)
    58_GPIO4 (=> RPI_1Wire)
    20_OWFS (=> OWServer, or OWX)
    21_OWTEMP (=> OWDevice)

- 2023-01-14 (6.2) 
  - MQTT2_SERVER: respectRetain is 0 (i.e. false) by default from now on.

- 2024-01-28 (6.3) 
  - no known changes