Announcement

Collapse
No announcement yet.

Version History

Collapse
This is a sticky topic.
X
X
 
  • Filter
  • Time
  • Show
Clear All
new posts

    Version History

    SDJ-Health Version History

    Version : 3.1.1.9
    • Corrected minor error in install file.

    Version : 3.1.1.8 (beta)
    • Cleaned up some minor things in html reports.
    • Added html wrapper files in //html/SDJ-Health so reports, when viewed within HS4, show HomeSeer header and menu items.

    Version : 3.1.1.7 (beta)
    • Wrapped the device strings in <div>…</div> pairs which cleans up the HS4 web page formatting of embedded reports. Thanks to zwolfpack for the tip.
    Version : 3.1.1.6 (beta)
    • Added writing battery report in html format to file. See section 4.4 of the guide.
    • Adjusted battery life calculation slightly as, due to rounding errors, for part of a day it would show the life reached the limit but not trigger an alert until later in the day.
    • Added current monitored device count to Battery Devices page.
    Version: 3.1.1.5 (beta)
    • Corrected a bug where a monitored device that had been deleted from Homeseer was not being removed from the plug-in in some circumstances.
    Version: 3.1.1.4
    • Corrected a bug in log monitoring that showed with HS4 4.2.17.x.
    • Corrected a bug that could cause duplicate LogMonitor parent devices in some rare cases.
    Version: 3.1.1.3
    • Version 4.x of the Z-Wave plug-in has removed (accidentally?) the ability to set the ‘Log Poll and Wake-up Messages’ flag from the GUI. These can still be set by modifying the Z-Wave.ini file directly. To make this easier I have added the ability for the plug-in to modify the Z-Wave.ini file to set the flag for your z-wave networks. See the beginning of section 4.1 of the guide.
    Version : 3.1.1.2
    • Corrected a bug in General Devices log scanning introduced in previous update.

    Version : 3.1.1.1 (beta)
    • Upated the General Devices section log searches to be more compatible with HS4. For HS3 plug-ins the Type field is used to dentify the origin of log messages, for HS4 plug-ins the From field is used to identify the origin of log messages.
    Version : 3.1.1.0 (beta)
    • LogFrom field added to the Log Monitoring section of the plug-in to be more compatible with HS4.

    Version : 3.1.0.10 (beta)
    • ‘<’ and ‘>’ replaced with html entities in devices strings to try and aid a user creating .asp pages.

    Version : 3.1.0.9
    • Work around added to cope with an issue in the z-wave plug-in where under rare unknown circumstances the ‘…Wake-up Notification Received...’ message was not being logged but the following ‘.. Wake-up Notification Processing..’ message was. In these circumstances the plug-in was missing the wake-up.
    • Added a lower limit of 5 seconds to the MinWakePeriod option to make sure that the above change won’t result in double triggering of wake-ups.
    Version : 3.1.0.8 (beta)
    • Changed default battery sorting to be by name.
    Version : 3.1.0.7 (beta)
    • Battery reports sorting, duplicates now sub-sorted by name. For example, if sorting is set by battery level then any devices with the same level will be sub-sorted by name.
    Version : 3.1.0.6
    • Battery reports sorting direction wasn’t be saved.
    Version : 3.1.0.5 (beta)
    • Corrected a bug that could sometimes cause false warnings after a plug-in restart for battery devices monitored by Polling or Activity.
    Version : 3.1.0.4 (beta)
    • Added sorting methods to battery reports. Battery Report Sort By, parameter and direction added to Battery Devices configuration page.
    Version : 3.1.0.3
    • Corrected a bug which was causing non-pollable devices to appear in the list of devices available for monitoring by polling.
    Version : 3.1.0.2
    • Added an initial delay (default 60 seconds) at StartUp before any battery device polling starts. This is to allow time for Z-Wave interfaces to initialize. This can be adjusted by adding a parameter to the ‘Settings’ section of the SDJ-Health.ini file (see 4.2.1 (3) in guide)
    Version : 3.1.0.1
    • Added Global Variables to the Log Monitoring section of the plug-in. When a LogMatch is triggered the following Global Variables are updated for the Log Entry that caused the trigger. These are all of type string.
    SHLogType
    SHLogTypeEx – The LogType with matched characters highlighted
    SHLogText
    SHLogTextEx – The LogText with matched characters highlighted
    SHLogFrom
    SHLogDate





    Version : 3.1.0.0
    • This version incorporates a whole new section entitled ‘Log Monitor’. This splits down into two main functions. One is to filter the historical log and produce reports which can be viewed or emailed. Typically a nightly scan to find any errors in the log over the last 24 hours and email this as a report. The other is real time monitoring of the live log to trigger events or scripts. Any number of search ‘Matches’ can be set up, using words, phrases or RegEx and these can be used for either or both of the reporting and the triggering.
    • The guide has been updated to incorporate the new features.
    • HS4 was reverse ordering the plug-in web pages, compared to HS3. The plug-in now detects which version it is running on and reverses the order where appropriate to be consistent between the HS versions.
    Version : 3.0.9.0 (beta)
    • This version incorporates fairly major revisions to the General Device section of the plug-in to add options to display filtered messages from the HS log in the reports for each interface.
    • Slight graphical change on General Devices config page to show Polling and Invalid State options inset, to better indicate that they can only be checked if Check Last Change Time is also checked.
    • The SDJ-Health interface itself is no longer excluded from the list of interfaces so can be set up to be reported on just like any of the other interfaces.
    • Log filters to search for words or phrases added. General Devices config page has Include and Exclude filters as well as period of time and max number of entries to display for each interface.
    • Each Interface has an option on the General Devices config page to Show filtered log entries.
    • Changes to status/graphic pairs to show when Log Scanning is in progress.
    • Changes to Reports to show the filtered log entries for each interface
    • Minor changes to cleaning up of devices for interfaces that have been removed from your system.
    Version : 3.0.8.9 (beta)
    • Added the ability to ignore some child devices when checking devices. As it is unlikely to be a much used feature you currently have to manually add the device numbers to a list in the SDJ-Health.ini file add restart the plug-in. See the end of the General Devices section of the guide for the method.
    • Added the ability to reset the InvalidValue flag, and corresponding ‘Unknown’ string, for devices on your system. See the General Devices section of the guide.

    Version : 3.0.8.8 (beta)
    • There is a bug in the Z-Wave pi whereby a call to poll the parent, and most of the child devices, returns ‘success’ even if the device is unplugged. It seems that for a dead or unplugged device, the Z-Wave pi returns an instant successful response when the Parent is polled, and a successful response at the end of the Z-Wave ‘Send Timeout’ period for most of the child devices. Battery child and Switch child devices do return an ‘unsuccessful’ response if the device is dead or unplugged.
    This doesn’t affect the Battery Device monitoring in SDJ-Health because, even where polling is used, this polls the battery child which returns a correct result. However, for General Device monitoring this was returning a successful poll result for unplugged devices.
    This version introduces a work round that ignores the Parent device and measures the response time when polling child devices. If the response time reaches the Z-Wave ‘Send Timeout’ (configured in the Z-Wave pi) the poll is considered a failure irrespective of the response.




    Version : 3.0.8.7
    • Corrected an inappropriate error messages when setting battery start levels for discharge rate averaging when LogToDatabase not selected.
    Version : 3.0.8.6
    • Options added to both Battery Devices and General Devices to have the Root Device string return to a set format after a configurable period of time. For Battery Devices ‘Status’, ‘Short’ or ‘Full’. For General Devices ‘Summary’ or ‘Detailed’.
    Version : 3.0.8.5
    • If running under HS4 general device report file names now don’t have spaces as these caused problems in the HS4 web interface.
    Version : 3.0.8.4
    • General Devices - Enabled ability to include devices that aren’t owned by a plug-in, i.e. virtual devices. These now appear as ‘No Interface’. They can of course be hidden and not scanned.
    Version : 3.0.8.3
    • General Devices configuration page is now OFF by default with a checkbox to enable.

    Version : 3.0.8.2 (Beta)
    • Corrected small bug in reported Last Change Time for devices in Invalid State.

    Version : 3.0.8.1 (Beta)
    • PollingDepth added for interfaces in General Health section. Default is 1 but if set higher then for a physical device represented by a group of devices the pi will poll that number of devices until a successful result

    Version : 3.0.8.0 (Beta)
    • Corrected bug where Check at Time wasn’t being accepted if in 12 hour clock format.

    Version : 3.0.7.9 (Beta)
    • Corrected bug where failed devices weren’t being added to list of devices for possible exclusion.

    Version : 3.0.7.8 (Beta)
    • Corrected minor bug where child devices were being recreated for hidden interfaces.

    Version : 3.0.7.7 )Beta)
    • Further major updates to the General Health Checking Features which are still in beta. The General Health Checking is optional and separate to the Battery Health Checking and should not interfere with the way the plug-in has operated up until now.
    • General Health Checking can now create a group of devices for monitoring and alerting. There is a General Health Root device plus a child device for each interface which is selected, e.g. Z-Wave, Insteon, etc.
    • Configuration pages separated so that there are now 3 pages, “Plug-in Configuration’ that is common to Battery and General (currently just LogLevel) plus the original page now renamed ‘Battery Devices’ and the new page ‘General Devices’.
    • General Health reports now produced in html format for better viewing.
    • For General Health checking, in addition to scanning for inactivity and polling, the plug-in can scan for devices in ‘Invalid State’. This can certainly occur with Z-Wave devices and may apply to devices of other interfaces, although I have not seen any on my system.
    • The guide has been updated to cover the General Health Checking features.

    Version : 3.0.7.6 (Beta)
    • Trial addition of General Health Checking Features – Refer to the thread in the SDJ-Health forum for details of this Beta version. The guide has not been updated yet but there is a basic guide to the new features posted on the forum.
    • Minor adjustment so that Battery Activity and Polling checks trigger immediately after restarts.

    Version : 3.0.7.5
    • Adjusted display of average discharge rate information.
    • Average discharge rate information is a global option but now only displays if the Display Battery Discharge Rate is selected which can be configured for individual devices.
    • Some re-wording of the Config page.

    Version : 3.0.7.4
    • Added option to display Average Battery Discharge Rate information in addition to the Battery Discharge Rate. This is refreshed each day for all devices and individually each time a new battery reading is received. See the updated section in the guide

    Version : 3.0.7.3(A)
    • Modified some text under Heartbeat Monitoring in the guide.

    Version : 3.0.7.3
    • Added the option to choose not to display the various types of monitoring in the device string of the monitoring children and the reports in the root device string. For each type of monitoring, i.e. wake-ups/level/discharge rate/life, if you choose not to Alert you can also choose not to Display the value. These options can be set globally on the Config page and overridden locally for individual devices on the SDJ-Health tab, if required.
    Version : 3.0.7.2
    • Corrected some spelling inconsistencies.
    Version : 3.0.7.1
    • Corrected a minor bug whereby if a device being monitored was deleted then when the monitoring child was removed the SDJ-Health root would still show the state of the deleted monitoring child until another device triggered a higher status alert.
    • Minor change so that the reference of the last device to raise an alert is saved over restarts of the plugin.
    • Minor change where displayed sleep period minutes is properly rounded where seconds is 30 or greater.
    • Change to improve the way monitoring of devices is automatically changed when a wakeup message or a poll is detected for a device previously monitored by a different method. This rarely occurs in practice.
    Version : 3.0.7.0
    • Minor change to the hidden status value of the Root device so it matches the status. This shouldn’t affect any reporting or event triggering.

    Version : 3.0.6.9
    • Corrected a bug in device grouping which was inadvertently introduced in an earlier update.
    • Removed RepairDeviceGrouping option as the ZWave bug has now been corrected by HS so this feature is no longer necessary.

    Version : 3.0.6.8
    • Corrected a minor bug in FindBatteryChild.
    • The history display in a device string now shows dates only, without times, for a more concise display. The full history display from the SDJ-Health tab of each monitored device shows the full date and times.
    Version : 3.0.6.7
    • Corrected a bug where text input boxes were showing truncated when viewing with the Safari browser.
    Version : 3.0.6.6
    • ForceBackToRoute option renamed to RepairRootDeviceGrouping. This option is there to help correct an issue in HS where the device grouping for some devices, particularly battery devices, is lost when the ZWave pi starts up. Previously the issue was that the root device’s relationship status would be erroneously changed to StandAlone but the list of child associations was still in the root. The issue appears to have got worse in that the list of child relationships is also erased. With the RepairRootDeviceGrouping option selected the plugin will repair the grouping by searching for child devices that are related to the parent , restoring the relationship and setting the parent relationship status back to Parent_Root. The change in name of the option reflects the more aggressive repair. Only devices that are monitored by the plug-in are repaired. Note that if you previously had this option selected it will default back to unselected so to use it you will need to reselect it after upgrading. If you have never seen loss of grouping in your HS system then leave this option unselected.
    • Some minor changes in logging where warnings that are unimportant have been relegated to debug logging.
    Version : 3.0.6.5
    • Cured bug that caused an error when building the list of battery devices due to Insteon devices having two childs with ‘battery’ in the Device Type (string). Now correctly ignores the Low Battery Warning device. Insteon battery devices can now be monitored using the Activity Monitoring method.
    • Cured bug where newly created monitoring devices had their battery last replaced date set to many years ago. Default is for it to be initially set to the last change time of the battery child.

    Version : 3.0.6.4
    • Corrected a minor bug that sometimes caused battery last changed date to be miss-positioned in history list.

    Version : 3.0.6.3
    • Work around added to retain monitoring of a device by polling even if its Supports_Status property gets changed from True to False by HS. This has been known to happen although it may have been a unique case.

    Version : 3.0.6.2
    • History buttons now only displayed for devices with database logging turned on.

    Version : 3.0.6.1
    • Added BatteryFactor that can be applied to devices that report a battery range that is greater or less than 100 to convert to 0-100%.
    • If batteries are replaced in a device set to check by polling and level is updated by HS3, the monitoring device will now change to ok without waiting for next polling interval.

    Version : 3.0.6.0
    • Now able to handle battery values above 100.

    Version : 3.0.5.9
    • Precautionary-Now force HS to save device after writing PED to root monitoring device.

    Version : 3.0.5.8
    • Added some polling messages to Log Level 1.
    • Added some additional error checking.
    • Removed some redundant code

    Version : 3.0.5.7
    • Corrected a bug that affected some installations using comma as decimal delimeter. Failed to read PEData for child devices.

    Version : 3.0.5.6
    • Updated device images to sdj-health.png.

    Version : 3.0.5.5
    • Changed the Device Type of SDJ-Health monitoring devices to support the Plug-in API property to improve selection on the Device Management page. Existing devices are updated on first run of this update.

    Version : 3.0.5.4
    • Added the last battery change date in battery history lists.

    Version : 3.0.5.3
    • Corrected some minor bugs which affected Local Settings overrides.

    Version : 3.0.5.2
    • Corrected a bug in writing discharge rates to the SQLite if your system uses ‘,’ for the decimal separator.

    Version : 3.0.4.9
    • Default polling interval changed to 360 minutes for new installations only. If you are upgrading and use the polling method for any devices then I would suggest you consider whether the polling interval that is set is shorter than necessary. Default was 60 minutes. You can change this globally from ‘Plug-ins>SDJ-Health>Config’.
    • Device configuration SDJHealth tab – Re-coded as there was a small possibility of confusion if you clicked on ‘Set All to Global’ and then moved away without Saving or Cancelling.
    • Device configuration SDJHealth tab - Additional Information added. Reference IDs and Monitoring Method. Full battery history list in scrollable region if you have Log to Database selected. Button for trimming (deleting) stored history data for the individual device.
    • Config Page - Additional parameter added to restrict the maximum number of stored battery readings for each device when logging. This prevents the database growing indefinitely. Click ‘Trim Now’ to trim the full database immediately, however each devices stored data is trimmed if necessary each time a new value is added.
    • Clicking the ‘History’ button on a device now cycles back and forth between the normal details and the battery history, if logging is selected.

    Version 3.0.4.8.
    • Installation and updating now uses updater_override.txt method.
    • SDJ-Health Guide added to //Docs folder.
    • Optional logging of battery levels to SQLite database added.
    • History button added to child devices to display logged battery levels.
    • ReTrigger button added to Health Root
    • Minor bug fixes

    Last version before guide was 3.0.4.3.
    Last edited by SteveMSJ; October 30, 2023, 06:32 AM. Reason: 3.1.1.9 released from beta.

    #2
    Sorry I had neglected to keep this version history up to date. I have however been updating it at the end of the guide document.

    Updated to 3.0.6.2 which has been submitted to HS so should be released shortly.

    Steve

    Comment


      #3
      Version 3.0.7.5 adds an optional feature to display average discharge rates, see the updated guide.

      Click image for larger version  Name:	Average Discharge.JPG Views:	0 Size:	21.9 KB ID:	1351732

      Battery Discharge Rates

      Each time a new battery level is reported the plug-in calculates the discharge rate over the period from the previous battery level. It is calculated as the percentage change in level divided by the period of time since the last reported battery level. If the level increases the discharge rate is reported as 0% per day. If 2 different battery levels are received close together the calculated rate can be very high. For example if the device reports 90% and then 1 hour later 80% that is a change of 10% over 1 hour which will be reported as 240% per day. Some devices are fairly erratic in reporting battery levels which can result in wildly fluctuating discharge rates. For this reason alerting on discharge rates is rarely useful which is why it is turned off by default. As with other parameters the global settings for Alert and Display can be overridden for individual devices if required.

      In addition to the battery discharge rate discussed above, which only changes when a new battery level is reported, additional information on the average discharge rate can be displayed in the status string of each monitoring child. To display the additional information select the global option Show Average Discharge Rate. The additional information consists of the range and the average rate of discharge from when the batteries were last replaced to today. It is updated each day and when a new battery level is received.

      This works best if Log To Database is selected and the date the batteries were last changed is set correctly, either automatically when the battery level jumps by more than the specified amount, or manually. If there are battery levels recorded in the database then the highest reading since the last replacement date is used as the starting level, otherwise the batteries are assumed to have started at a level of 100%.

      Steve

      Comment


        #4
        Plug-in has been updated to 3.0.8.3. and submitted to the updater. It might be a few days before HS add it to the general updater but it can still be installed from the beta section in the meantime.

        This is the first non-beta version with the Health Checking of General Devices added. This is OFF by default so if you want to experiment, turn the new features on from the SDJ-Health>Config page. The new features are separate from Battery Device checking so should not interfere with anything you already have set up.

        Comment


          #5
          Submitted 3.0.8.6 to the updater.

          This has optional features added to reset the format of the displayed string in the Parent/Root devices after a period of time. The option is available separately for both the Batery Devices health root and the General Devices health root. A fairly minor feature but I find this useful as I have the parent string displayed on HSTouch pages. I have buttons on the page to change between the displayed formats, e.g. Status Only, Short and Full but I generally want it to be set to Short. I now can configure the pi to reset to Short after 5 minutes, for example.

          By default these features are Off so there is no change to how the pi operates unless you set it.

          Steve

          Comment


            #6
            3.1.0.9 of SDJ-Health previously the Beta is now the Release version.

            Steve

            Comment

            Working...
            X