HMinfo is a module that shall support in getting an overview of
- eQ-3 HomeMatic devices as defines in CUL_HM.
+ eQ-3 HomeMatic devices as defines in CUL_HM.
+ Status information and counter
+ hminfo tries to give an overview on the CUL_HM installed base including current conditions.
+ Readings and counter will not be updates automatically due to performance issues.
+ Command update must be used to refresh the values.
+
+ Webview of HMinfo will provide details, mainly based counter drivern, on how
+ many CUL_HM entities experience certain conditions. Areas provided are
+ Action Detector status
+ CUL_HM related IO devices with their condition
+ Device protocol events which are related to communication errors
+ count of certain readings (e.g. batterie) with their condition - attribut controlled
+ count of error condition in readings (e.g. overheat, motorError) - attribut controlled
+
+
+
It also allows some HM wide commands such
as store all collected register settings.
@@ -489,7 +628,7 @@ sub HMinfo_post($) {###########################################################
If applicable and evident execution is restricted to related entities.
This means that rssi is executed only on devices, never channels since
they never have support rssi values.
- Filter
+ Filter
can be applied as following:
set <name> <cmd> <filter> [<param>]
whereby filter has two segments, typefilter and name filter
@@ -515,56 +654,60 @@ sub HMinfo_post($) {###########################################################
set hm param -dcv expert # get attribut expert for all channels,devices or virtuals
-
-
- Define
+
+ Define
define <name> HMinfo
Just one entity needs to be defines, no parameter are necessary.
-
- Set
+
+ Set
even though the commands are more a get funktion they are implemented
as set to allow simple web interface usage
- - models
+ - update
+ updates HM status counter.
+
+ - models
list all HM models that are supported in FHEM
- - param <name> <name>...
+ - param [filter] <name> <name>...
returns a table parameter values (attribute, readings,...)
for all entities as a table
- - regCheck
- performs a consistancy check on register readings for completeness
+ - peerXref [filter]
+ provides a cross-reference on peerings, a kind of who-with-who summary over HM
- - peerCheck
+ - register [filter]
+ provides a tableview of register of an entity
+
+
+ - configCheck [filter]
+ performs a consistancy check of HM settings. It includes regCheck and peerCheck
+
+ - peerCheck [filter]
performs a consistancy check on peers. If a peer is set in one channel
this funktion will search wether the peer also exist on the opposit side.
- - configCheck
- performs a consistancy check of HM settings. It includes regCheck and peerCheck
+ - regCheck [filter]
+ performs a consistancy check on register readings for completeness
- - peerXref
- provides a cross-reference on peerings, a kind of who-with-who summary over HM
+
+ - autoReadReg [filter]
+ schedules a read of the configuration for the CUL_HM devices with attribut autoReadReg set to 1 or higher.
- - saveConfig
+ - clear [Protocol|Readings|Rssi] [filter]
+ 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
+
+ - saveConfig [filter]
performs a save for all HM register setting and peers. See CUL_HM saveConfig.
- - clearProtocol
- executes a set clear msgEvents on all HM devices
-
- - clearReadings
- executes a set clear readings on all HM devices
-
- - clearRssi
- executes a set clear rssi on all HM devices
-
- - autoReadReg
- stimulates a read of the configuration for the CUL_HM devices with attribut autoReadReg set to 1 or higher.
-
@@ -574,9 +717,39 @@ sub HMinfo_post($) {###########################################################
-
- Attributes
-
+ Attributes
+
+ - sumStatus
+ 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
+ sum_batterie ok:5 low:3
+ 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
+
+
=end html
=cut
|