/* * Watchtower app for Hubitat * * Data-driven insights for a smarter home. * * @see https://codeberg.org/dan-danache/hubitat/src/branch/main/watchtower-app */ import groovy.json.JsonBuilder import groovy.transform.CompileStatic import groovy.transform.Field import java.math.RoundingMode import java.nio.file.NoSuchFileException import java.time.DayOfWeek import java.time.ZonedDateTime import java.time.ZoneId import java.util.regex.Pattern import com.hubitat.app.DeviceWrapper import com.hubitat.app.InstalledAppWrapper import com.hubitat.hub.domain.Event @Field static final String APP_NAME = 'Watchtower' @Field static final String APP_VERSION = '4.0.0' @Field static final Pattern URL_PATTERN = ~/^https?:\/\/[^\/]+(.+)/ @Field static final String APP_ICON = 'iVBORw0KGgoAAAANSUhEUgAAAgAAAAIABAMAAAAGVsnJAAAAJ1BMVEVHcEyAugB6tACAuwB5sgB/uwB4sgB/uwB2rQCAvABypgB3rgCAvADOha9yAAAADHRSTlMAGTtVbYaeudPl8vuPQkR9AAAV4UlEQVR42uzWMWsUQRjG8WfmLv2ht3ftBI3XLkQ8061BUMHiFkEs0mwlgTS5gFpsIRfstjMkCPtxkt0sPB9KMjuFg50w7sK8v2ZgmuE/uwwvhBBCCCGEEEIIIYQQQvyzJx+/fjlGtOYlyTYFsI8I6U8k2RqoF1UBKEQmqVz/vOxy4NAgKuotH3SpWvM+w+PPkfVPyr4/02dsU/WmNWvEJKlp5UnNxhxUrXlJg3gs2CvWZPO8ZGtW7AyisWTv4tQutp/n8X3/m+qP/t3TVwhgko63v2PvPl2Q16csEEKSY2QS+ro0IbuKO4SRXGBU9mp6uuxhp+YtoF/vI4Dk2mA8pn/19zvtDLokf5gQZ96kGAtd0dNtJrVdU9tPfkcA+luGcVAlfXmfzY3rb2YIQf/KgUcY3gl95+5Gdm40DjYMLZlDHWJoR/Rt1ZldbzGp3I8QyrO6gPqAYS3pu1Qn7B9A9zQWCEcfDH4DU/qu8M4NAq5/G/j8AvoYw9ElPXc4opW7/ksEluRQGM57eprZitbW9V8huEWO4azoac2C1k+vP7DlZiwPQJfu0Wrmff/dDP/DKhvJBLiZ1r+ZsX/WtoEwjuPfk2x5vQ6N3E2FQtF2dKohg0oDbSGDQ2m7eIihzZQhspt/4CUt3jTJQxa9HMeyQS8qnLCHC3iz7vR5Bz94nnueeyqtfGc1P3yJWvEATPyi0jYnxfZBwBLxS7o5ARgWu4nwZ1sHEdZ41xLrvMIcgK8uq9qN/fzgn7tugPLtqKo9usj/yfkKvFHfqtraRX6OJ64bYDwwToKlwiIPr0ipCUcNsDDrYa2wyftPWCXUfkisCMwH4PWLfsCueMKolGh+7uIIdFIY+RMsE7MzL1tSixMsiI3888xtfujoLTxFE7eSxvlmA5jlcIYDYSnDbed1cstXwE3mPj8MlgxWEm2gaFjPSPxiHuLIKBWXOZqY0yyRVXvluCLulV8M0YKURr2p9nrCHf9RHq0jtK/S2g5oKiMc6uYcL9G8BeDRkONqrwSn4qHIUrR+AmJoYQSaUtwStzLYRGgXwJFsfASalrjW2TUBnRTEGITkwLrVPmuJc3EisnO0jxLCCMYc2KzaZ4h74oaglADePxBTCKLmdiBTTht0HjjN0cIEegomlgpgRTvEyisUgLgG/gp6igMKWzgBTWJO/wmtm0Dve8S0oTOA6YGW8N9fMRuyc/GBUFkogBVtIeZ3sluyE/xWYmrhF6RojfAu5/SKnZ+f6SsOpN/SCWC636hn6uyeRWogjAP4f5LN5ezGQ2EDFuEUdWGLcCoopDgVwSLFInIgWAQ8C2GLLCoqbHMHIsIVzvrW7KfJbjYb+H8omcB1t4WXWZj5ddMl8Mw8b34tpZDQgreH4hRmiDkvVktYJOASg+LT1a9oHR2hH285AHJYJePI+xvNohNoveNcnG43BSxgF581ovc8aGJoD56hL7dZBDYxLDPkRPxNF8MZNP9lIibbLAInsI03b2T/mPeaGNq9p7gjtxcAK9hnQCV+Z4t0hlaQeBN0Nt7YBNpH6BB4yYNGovUGd9DVjhMv4LmISvzKFqlCK0y8eFuDoBiwNASi+7y1lhLaezxDN73NNaC1IfAzK6dFD1o/DkboJN08BrM2BAY3+agWeXs87dgVe5tToL0h4M3S1by4Da0v+/EWlkE1rOXpENgnV37eHguhttAH57DXgCe+GpKjI2gHeGi+CKpgMY9r+WqPXO6M0Apy40XQIWw25GTnZEgmH4HWB9PLkCWs5rPG5z2yjJ7E0HZjwzkwgd0yFmGRstmrFDShzObABSwXsBbffFKlXyS0u2YnQQlsN2YeFSnrHgtovdzkIGAB64WsxB+fLMY1Wscmn8AE1hNnPBzkr1mFzKGF0twTuIQDIi691Q75+KzCpQkHa4BzHpmk+RkXEQ8NtwEVnJCy7NUpuc/S8Cx0BCcEZDz+Tqq0kddMTkJWcMSUs12S6+sswhiXcYMXKeCIiM1VkiymladwGXNeYA1XCFJlJKtdxs+lsWGwgjNS1iFJPp6rsDBVBDQSzgjIFyRZpivx29RGvIRDpqymJJvrTIaJoVFQAodEZEtNq0CZWYdUcIkgW3XEk09mJgEFnJKSrTesoxH+z65lObBTN7sY86A0cQMUHHNGtgZUr6SBRjCG5uAz+JNVmHe/AUu4xidbqyn3S/yPzKptUPe1xpTqXecb0Eg45wrPrbO8axVUwj3eJb8/c7cK3PwnTccbsIIbNsfyqFsn/AP/2juf5ziKK473/FiNltJhwQJFjg5rmxQ4NYdN7ECZ2sMa20VR2YP44WDIHJQYlxO8B5FgFw57UFJFQmwd5JBAUjUHDA6pknXhEELJOngj7a4WvT+K4gaj+U7PTk9rpp/2Wxw4qKztN59+7/tet2bNEO7peiKtfGACDN8DQ6Vp6I4wU16GLOaCPsjwPZB+F88DE2D8HugrNELbwlR5Yz9FS78Nth6Nkx7IrLFX4eneAbN/eBCv9ctCg4JxzWBT8w6orG8REe3Rt/rO/xLtbX4m8tf0uIVwVe8OsG4R1qaGjtMe08y4mnfA0S1K0Oe6euL0xbyqeQfcpiR93dI0F0q/kECvC3I2KFF3tb4BdzfjiVCOO+ARSta/9cxG07vhiuY+4MeUrK/1vv1mLdOtgBWRn34uC0BNqxmUJ4FAcyd8TRaAulYzOJL+rO5Z0G1ZABp6C2EjQwq4oyEhQe21hNZCuJYhBbQ0BECzEcCPdXv8FDASxhMgQuwE5C5gWxhIAJ6KNMZuBJYZEFDFy5E3AnUGBLhpZwJtUASNIwAngeG4lyN7ggEBop2OaAdcjjafgCoa7sjHgTUWBLjpkPbBzTjzCRBhqhV1gA82nwARAKalnVCLCQELabJaBfhgDgRU0vRDVZACOBBgpfH2TZACOBAguin6oS5wARwIEL7cCtngRIQHAdPyfmgKpABDCFC3QlXQCPAgwApxf4dbwSWTCcBWKH0OrPMhQPjQ3WEfOBSMCPBkJz0VcD2YCwF4KoRz4AonAvBUCPfCLbMJwL1uLWUvLFgR4EsMbghsEBsCpkFDiOeBPV4EuKAhxPPAZV4EWKC+42PRBgMCgNOrpRkGjAQDAsASW2mM8EAwI2AmMQsCH8iJgCmwNlQEVrgR4AC6URFocSNAJOW3GXAoxoQA+WWpJuiFWRHQTPA4HXA1xmwCMOYP5Z1AjxEB8iujNpgH8iLAwRu8AowwLwIs3OpPgyLAiwDRhc93ARQBXgSINtzhTVAEmBGwAMtABxQBZgRU4QMOwTSEGQEVNO+zQCfAjQAbdQMuKALcCBBogR4YB3EjQHQB4lUwEmdHQBskOR+Mg9gR4IOpWJuiesiTgCp4xB1QBdkR4IFNHoIqyI4AN+L1sQ2o8yTAiq+DDqiCTAgArDeSpgFDwYUAbAQWk3zQDkcCsBGYATaAIQF+bKX3gQ1gSMBM5CEjH7TMlQAvss2RD1rkSkAlkujRp6pzJcCJLfVgGsCMAOyEbPAWcWYEYCfkgMshzAjATqgCfBBLAoKYUucBH8SEAPxSITwQ6zEiAFvBHnbCa5wIwFYQO+ElvgRMx2S6JjCCLAmYiql1AUXV4EgAHop1gRNmQgD2wjgAojQEPHY8Vsdy9cIhcMLFE2C/tbker68yk7IfdAtMBIsnwL61BQO13lL/BA3UC/VLQsBzW4T1eW7NgANagcIJcDYSf3Ipr2bABa1A4QQcpUTdU58Lo2awVw4CrlGiNvM6IPbATLhoAqwNWayUb4qhAKyVggB3QxKrFeVuCHXDy6UgwNuiZH2ifFUOdcNLpSBgmiT6IqeTgQXQDBZNwCMk0aeq7WAfjQNaBRKgMwDRojdAAWhwJAD3w03QDbMhAPfD6Gi0xpWAaOuDBkKCIwF4IBCAC0LMCMD3hTsgAMwIwBORLpiH8CEAH4+CAHAjAN8Yjw/AgCUBeCS0CgLAlYBOtOkJwUiQDwF4JgYCwJsAeQB2mBGAh4Jr8QHYZkCAWgB4E9CMDgWJOwE4AD0QAN4E+NGpKDgXYUCAQgBYExBlPTxkBCyAAPAlAAdg57ATsHPYCegfdgL6h52AQeQzsSYAB6B7eAkYggDwJkAegO1DRkAHBYA/AbsgAMx7gegRUJDHSGz2N7fW4/TBm7WSEIAD0M4hAE+tb8XrweZ/6mUnoKk+FXbvJyzpXtkmQhoC8Jb0TmvxBOAA+GonQ/IbffdKNhWOBmBBOQBHJYuqlfJkCAdgqPCd+mAPlOpsMBqAGeUAbMivdBZPAA5AVfWGiL0h+6RlvR8wApelx82BW5Sse8USgM3obj4BqMgC8N9SERBGAzClek9wShaAL8tEgLUv21Uoqrq+ABRPgL0vAA5F1eBIAA6ATVG1OBPg7rN8FkW1yJmAyn7PS1EtcSbA29/2hRTRMmcCpiOTj7ip6BpXAqLOfxu8SuwhZwIWIgGIm4n1OBPg7z8BaYKTEZ4EtPc/aR9MRXkS0Ins9biBQJ8zAav7s30VTER4EhDzfXIeRbTLmACbKMULBBgT4MRYXhcMBFgSUInp+mzQD7MkYDqyTtAO8iVgJm7yE4J2kCMBfmSrg26ILwHtuPl/G3RDHAnoxvkdHzQDHAkI4w5BF0AzwJAAO7JM4IUHbAlwY0GfAl6YIQFeZO6BvDBbAqqRYoesYJ0rAX6kF0JWsMWVgHbE8EIryJWAbnzL0wFWkB8BoOkFc2F+BNiRVA+t4DZTAipg8jcDnBA7Ajww+wVTQX4ELEQwx06oxpOAJkh0YCjGj4BOzFAcXBHgSUAI1ghmQuwIsCDlATACzAhwQZ4D56P8CPDAjWBwYZofATNwiR5FxZIAH0AObovyIyCAk18bHA4xI2AVz/5DUAdZEWAlXAbsgDrIigAXTL3A387xI8ADWQ7UQX4EzMTYAFwHa/wIaCaMPFwwGGZFQCdmGoAn48v8CAhjsjz+ZD12BDgEpgHgLQLsCJgCTg/0g0N2BMwkev0qKAOGE4C9DuADMMKCgC4AHLVDa9wIwCkOvFKMGQEuKHKwHRowI8ADfMMyMGJGgA8yHC4DDV4EBKAK4jKwzIuAEOCNy0CPFQEOGnfgMtBnRcA0KnG4GxixIsCXmhwfZEEmBHSlNncaZEEeBFiSYw/w7bN8CKjgGzB4KDRgRMA87gTwJYFRjQ8BQYoK3wSDURYEhCC7JZvhNTYEuJL6Bo6It9kQUAUOR5IFd9kQ0AYeV5IFqc6FgBDkQFkWXGZCgJtuWVVghcwnoApyoDQLDpkQ0AQ5UJoFqc6DgBDkQOlglJZYEOCiSY+8I+6xIKCKnqq8Ix6wICBIu68dkAQMJ8AKU2f2EDgBswmopDf4beAEzCZgIX2LNw+cgNkEdNI3+RWQBIwmwALD7pRWaCXXFyu/JwtAI30A7ma6GkM7ybRkmAm4G+lfrX1NFoB6tCZjfZHpRIDuSPMFJkb95erPyXLAGGB9kulEgBblh+gwZ6i/Xv+HlKyv0sd1Dxg6mbmpyf+6GCAD9UsJ1t+JuSd5rJ+BuILdksEH92W8QDes/hUb8se6tyJSb5f/ZfHB8u7Gz1AInY3UT1W8IXuqaWnZu5upCNKitGZkcMNvpN0BQngbqWNl3aYEbabcAR467EnvBLYVv2gpEqwtglr//qK8+wlh/TRbEeyn8o0gaFhPbD6gPdqK+W/zy1okzb53f2sr9mcfrL8kvq+n1x/E/6t7m/dESoXjpvQFynJn9MjVD2L1l8u1fYw98278z17ZD/Us+Gf//HLGYRC1UhhH0BGaqXls69IngV1hrjoon2EFwAwaKRu0dmMmgZ4wVdUMY36XwFTERAVZFhLy2QN2JpSbfPaABwp6sjw+eyAAlk7GDZc9YANTL1OHyx6Yznj/fZ6LFwpAEcxQCGmRwQ7oq3xB9v8Z7IA7Ga6WgwRqhjqZX5A2RWAuZJSc7LXcijGDO+Z1wgqVrElgNmqSugpexiNwPmCQKipu1iLz7bCvVMfaxlsBK1Ry8x6B8bgx8tS8rEWmp8FAsZtpG54GHdV+1jM8Dfrgsyt5IVoyKAUq09skk92gR6gPUOoHqGFqHzRQgMjEpriSR/72ydymuJlHBa9QjP5ozihIPXl1ja2EJ/MZZsyToXMRK8xn59oUo4E5kxD13N0mI3tCaxXbYHU7TH3jhsE0VNhLBiJgdfMrXQtkoB+ey9G8OBSnljEAqNvXwDwE5nJ9YB6BLGBQCRio/XOmITCfs3WbNwwBO8QpMD83SH1zugD6m3pjadBszM1/huMSGdQUBhpg7VCc3jahBGJW1Svhbq2UbbAWVLtEhhySnNEzvvgBxWlUL18GhKCqg2XCUanV1cXpPBnhhk5qG2LboQml0AHHGBpiW84ReaDxPN+m8ufBOa1pyicqb1eIt2lDw0lLWVuCtuY61aRy+8E5AgDoRmC7LBtA+2fzS70J2gAADTEuZSWYO4gMfbKcmwA/nJaG31LSyUBwMA9mntAmKOMGoIaWgXsZJ6ROCADQFmkwdy1IVufgsOxSCWvhmQN8JlNUvjTwBNEBXmYLCKhfK0MC0F+ZHEL6sEwJgIY1jVOnUrmBFylWyzrPnoFGLXHwevrg6/IcIe3WC0uA2ATrz4N44+mXGxZhSxyC+nsBBaCAIc1JKkcpsLsFpWOrS1C/O+BjoGKu8lYI61cHagCKusN3pvgIWEGRjZm1SlCjlwp4/hozIG6KsCEqcv20VEALChjQy3/BA0prtQAGQP0r5pymQoUx4HSpgA0A7BCSxgg4CfBtF9CIA/1aaNLjIRWwAaATx/q90KKnKEFLBU/j9XdG1ouUoA8LmcZgDeq5p/9O4u+rFXMrDWt0VuSq2dXE39YobCKLdVnkqGcpUW8XOJPH+qiRG/6vK6Qc7ZYYa5QTBD8CsBUwjgOuHGp4VsPjV3Df2nw51vW6hsePE0Bxk1msd1RCcOS3BAQcQAGJUCMF9iUCKvJ+AnanWO//JMvyXyC5hvVS/ZkG1kfPj7v810KSa9Qo2x0lrOErtTH2/muUSosCqMDWGGt0Pd1OsH52k6BwAShRMcT6WIqB9eTVkFLqT6Jo4TEN1o1zOG89dhqsXqEAFtgXYQ6unDsmIrJOnL76VwJS6ACKNkRY/7xx5eL58+dPnT7/6sWr7/6LkEp0MwmrEpKiTFo/HlfyXz/WrK4I4BEYgwgweP4gE2rWP8D6GUTAkPqHD+60Cx+7GOCKFSU/eDOoM5ILHz6XWtbrpFXDhii7nmWe/uV6nLTpsjBCs6ua8D8rDJGtJRG8L8GfeSIYvSyM0mw358dfF4bJeiHP3S8p/twheKcmjJT1TEgKAtcMjJJ9SX35ptQ+fLqroo+fF8bryZvcly+n4FK2yvdTwUZHwEkv1vDNuuAjfN6JD1EZyk4Xg93rDNDHJ7+/SAzC6MYrxwR3WScuXL0ZxpwUXjwFFs9Sjx4/cfrChYvf6tVzp44/KiaaaKKJJppoookmmmiiiSaa6MD0DQrj3ghNx49LAAAAAElFTkSuQmCC' @Field static final String MASKABLE_ICON = 'iVBORw0KGgoAAAANSUhEUgAAAgAAAAIABAMAAAAGVsnJAAAAElBMVEVHcExxpQBxpQBwpQBxpgCAvACY5M8+AAAABXRSTlMAJ7Ti/ZKd2DUAAANgSURBVHja7d1BctowGIZhAxcgkANAwwEo4+wbW75AY93/Kl22ixJJaQnw8zx7zTCadz5WHnUAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAwB8WT+esuwew6dN5476L7iXN+bw5fe9i26b8sRS7gUXKJWPoIXiecsl87ALrc9nQxbWYctm87sJaVV3ALvAE5BpvXVgHF5AfewVfH/0Cplzj/dEvYFSAAhSgAAUoQAEKUIACFKAABShAAQpQgAIUoAAFKEABClCAAhSgAAUoQAEKUIACFKAABShAAQpQgAIUoAAFKEABClCAAhSgAAUoQAEKUIACFKAABShAAQpQgAIUoAAFKEABClCAAhSgAAUoQAEKUIACFKAABShAAQq42wI2L306ZzztwxewSanwME3sApbFh2l2oQtY9OUD68gFrGoepolcwCGXDdEKaH+YJm4By6oLOMYqINjDNO0FtF/AKVgB7Q/TxC3gUHdncQt4zTXGWAW0X8D86AXMj15AUoANUIANUIANUIANUIANUIANUIANUIANUIANUIANUIANUIANUIANUIANUIANUIANUIANUMAFFD5m+bYOvwHbNH0gpX3wAjblj1mibUDrxyxD6AK2Uy6Zd5E3oM9lb8EKaP+YJfAGrKouYBe3gOdcYT7G3YBDrvEWq4D2n3aKuwFTrjEEK6D9AsJuwGLKNX6GLWBxSwXMCghwAUE3YFDAl2yAAmyAAmyAAmyAAmyAAmyAAmyAAmyAAmyAAmyAAmyAAmyAAmyAAmyAAmyAAmyAAmyAAmyAAmyAAmyAAmyAAmyAAmyAAmyAAmyAAmyAAmyAAmyAAmyAAmyAAmyAAmyAAmyAAmyAAmyAAmyAAmyAAmyAAmyAAmyAAmyAAmyAAmyAAmyAAmyAAmyAAmyAAmyAAmzArReQ7uSdode6aNqPvIe6gKH9RbPxTt4aO1zqyHDrr819/shz5ZErqPtpx/YjP+7kAla5wrz7x0cql5VHbvV/MLUfmdefOXINffs6HS515E7eHe5W7UeWFUeO3c2+PN1+ZFx/5sh1bGvfHv9teaEjV7uBaT4f5pz2fz0yNR7ZFI9cz+alT+eMp6f/dOSpcAQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAACAu/cLBQBL1l75RF4AAAAASUVORK5CYII=' @Field static final String HUB_NAME = '🏠 Hubitat Hub' @Field static final List HUB_ATTRIBUTES = ['hubCPU', 'hubRAM', 'hubTemperature', 'hubDatabaseSize'] @Field static final Map> SUPPORTED_ATTRIBUTES = [ hubCPU: [min:0, max:50, unit:'%', minMax:true, probe: { device, app, events, begin, end -> app.state.hubCPU ?: '0' }], hubRAM: [min:0, unit:'MB free', minMax:true, probe: { device, app, events, begin, end -> app.state.hubRAM ?: '0' }], hubTemperature: [min:0, unit:'°C', minMax:true, probe: { device, app, events, begin, end -> app.state.hubTemperature ?: '0' }], hubDatabaseSize: [min:0, unit:'MB', minMax:true, probe: { device, app, events, begin, end -> app.state.hubDatabaseSize ?: '0' }], acceleration: [min:0, max:100, unit:'% active', minMax:false, probe: { device, app, events, begin, end -> calc5minValue(device, 'acceleration', ['active'], events, begin, end) }], airQualityIndex: [min:0, max:500, unit:'', minMax:true, probe: { device, app, events, begin, end -> calc5minAverage(device, app, 'airQualityIndex', events, begin, true) }], alarm: [min:0, max:100, unit:'% active', minMax:false, probe: { device, app, events, begin, end -> calc5minValue(device, 'alarm', ['strobe', 'siren', 'both'], events, begin, end) }], amperage: [min:0, unit:'A', minMax:true, probe: { device, app, events, begin, end -> calc5minAverage(device, app, 'amperage', events, begin, true) }], battery: [min:0, max:100, unit:'%', minMax:true, probe: { device, app, events, begin, end -> "${device.currentValue('battery') ?: 0}" }], camera: [min:0, max:100, unit:'% on', minMax:false, probe: { device, app, events, begin, end -> calc5minValue(device, 'camera', ['on'], events, begin, end) }], carbonDioxide: [min:0, unit:'ppm', minMax:true, probe: { device, app, events, begin, end -> calc5minAverage(device, app, 'carbonDioxide', events, begin, true) }], carbonMonoxide: [min:0, max:100, unit:'% detected', minMax:false, probe: { device, app, events, begin, end -> calc5minValue(device, 'carbonMonoxide', ['detected'], events, begin, end) }], contact: [min:0, max:100, unit:'% open', minMax:false, probe: { device, app, events, begin, end -> calc5minValue(device, 'contact', ['open'], events, begin, end) }], coolingSetpoint: [min:0, unit:'°C', minMax:true, probe: { device, app, events, begin, end -> calc5minAverage(device, app, 'coolingSetpoint', events, begin) }], door: [min:0, max:100, unit:'% open', minMax:false, probe: { device, app, events, begin, end -> calc5minValue(device, 'door', ['open', 'opening'], events, begin, end) }], energy: [min:0, unit:'kWh', minMax:false, probe: { device, app, events, begin, end -> calc5minIncrease(device, app, 'energy') }], filterStatus: [min:0, max:100, unit:'% normal', minMax:false, probe: { device, app, events, begin, end -> "${device.currentValue('filterStatus')}" == 'normal' ? 100 : 0 }], frequency: [unit:'Hz', minMax:true, probe: { device, app, events, begin, end -> calc5minAverage(device, app, 'frequency', events, begin) }], goal: [min:0, unit:'steps', minMax:true, probe: { device, app, events, begin, end -> calc5minAverage(device, app, 'goal', events, begin) }], heatingSetpoint: [min:0, unit:'°C', minMax:true, probe: { device, app, events, begin, end -> calc5minAverage(device, app, 'heatingSetpoint', events, begin) }], humidity: [min:0, max:100, unit:'%', minMax:true, probe: { device, app, events, begin, end -> calc5minAverage(device, app, 'humidity', events, begin, true) }], illuminance: [min:0, unit:'lx', minMax:true, probe: { device, app, events, begin, end -> calc5minAverage(device, app, 'illuminance', events, begin, true) }], level: [min:0, max:100, unit:'%', minMax:true, probe: { device, app, events, begin, end -> calc5minAverage(device, app, 'level', events, begin, true) }], lock: [unit:'% locked', minMax:false, probe: { device, app, events, begin, end -> calc5minValue(device, 'lock', ['locked'], events, begin, end) }], lqi: [min:0, max:255, unit:'lqi', minMax:true, probe: { device, app, events, begin, end -> calc5minAverage(device, app, 'lqi', events, begin) }], motion: [min:0, max:100, unit:'% active', minMax:false, probe: { device, app, events, begin, end -> calc5minValue(device, 'motion', ['active'], events, begin, end) }], naturalGas: [min:0, max:100, unit:'% detected', minMax:false, probe: { device, app, events, begin, end -> calc5minValue(device, 'naturalGas', ['detected'], events, begin, end) }], networkStatus: [min:0, max:100, unit:'% online', minMax:false, probe: { device, app, events, begin, end -> calc5minValue(device, 'networkStatus', ['online'], events, begin, end) }], pH: [unit:'pH', minMax:true, probe: { device, app, events, begin, end -> calc5minAverage(device, app, 'ph', events, begin, true) }], power: [min:0, unit:'W', minMax:true, probe: { device, app, events, begin, end -> calc5minAverage(device, app, 'power', events, begin, true) }], presence: [min:0, max:100, unit:'% present', minMax:false, probe: { device, app, events, begin, end -> calc5minValue(device, 'presence', ['present'], events, begin, end) }], pressure: [min:0, unit:'psi', minMax:true, probe: { device, app, events, begin, end -> calc5minAverage(device, app, 'pressure', events, begin) }], rate: [min:0, unit:'l/min', minMax:true, probe: { device, app, events, begin, end -> calc5minAverage(device, app, 'rate', events, begin, true) }], rssi: [min:0, max:255, unit:'rssi', minMax:true, probe: { device, app, events, begin, end -> calc5minAverage(device, app, 'rssi', events, begin) }], securityKeypad: [min:0, max:100, unit:'% armed', minMax:false, probe: { device, app, events, begin, end -> calc5minValue(device, 'securityKeypad', ['armed home', 'armed away'], events, begin, end) }], sessionStatus: [min:0, max:100, unit:'% running', minMax:false, probe: { device, app, events, begin, end -> calc5minValue(device, 'sessionStatus', ['running'], events, begin, end) }], shock: [min:0, max:100, unit:'% detected', minMax:false, probe: { device, app, events, begin, end -> calc5minValue(device, 'shock', ['detected'], events, begin, end) }], sleeping: [min:0, max:100, unit:'% sleeping', minMax:false, probe: { device, app, events, begin, end -> calc5minValue(device, 'sleeping', ['sleeping'], events, begin, end) }], smoke: [min:0, max:100, unit:'% detected', minMax:false, probe: { device, app, events, begin, end -> calc5minValue(device, 'smoke', ['detected'], events, begin, end) }], sound: [min:0, max:100, unit:'% detected', minMax:false, probe: { device, app, events, begin, end -> calc5minValue(device, 'sound', ['detected'], events, begin, end) }], soundPressureLevel: [unit:'dB', minMax:true, probe: { device, app, events, begin, end -> calc5minAverage(device, app, 'soundPressureLevel', events, begin) }], status: [min:0, max:100, unit:'% playing', minMax:false, probe: { device, app, events, begin, end -> calc5minValue(device, 'status', ['playing'], events, begin, end) }], steps: [unit:'steps', minMax:true, probe: { device, app, events, begin, end -> calc5minAverage(device, app, 'steps', events, begin) }], 'switch': [min:0, max:100, unit:'% on', minMax:false, probe: { device, app, events, begin, end -> calc5minValue(device, 'switch', ['on'], events, begin, end) }], tamper: [min:0, max:100, unit:'% detected', minMax:false, probe: { device, app, events, begin, end -> calc5minValue(device, 'tamper', ['detected'], events, begin, end) }], temperature: [min:0, unit:'°C', minMax:true, probe: { device, app, events, begin, end -> calc5minAverage(device, app, 'temperature', events, begin, true) }], thermostatSetpoint: [min:0, unit:'°C', minMax:true, probe: { device, app, events, begin, end -> calc5minAverage(device, app, 'thermostatSetpoint', events, begin, true) }], transportStatus: [min:0, max:100, unit:'% playing', minMax:false, probe: { device, app, events, begin, end -> calc5minValue(device, 'transportStatus', ['playing'], events, begin, end) }], ultravioletIndex: [min:0, unit:'', minMax:true, probe: { device, app, events, begin, end -> calc5minAverage(device, app, 'ultravioletIndex', events, begin, true) }], valve: [min:0, max:100, unit:'% open', minMax:false, probe: { device, app, events, begin, end -> calc5minValue(device, 'valve', ['open'], events, begin, end) }], water: [min:0, max:100, unit:'% wet', minMax:false, probe: { device, app, events, begin, end -> calc5minValue(device, 'water', ['wet'], events, begin, end) }], windowBlind: [min:0, max:100, unit:'% open', minMax:false, probe: { device, app, events, begin, end -> calc5minValue(device, 'windowBlind', ['opening', 'partially open', 'open'], events, begin, end) }], windowShade: [min:0, max:100, unit:'% open', minMax:false, probe: { device, app, events, begin, end -> calc5minValue(device, 'windowShade', ['opening', 'partially open', 'open'], events, begin, end) }], variable: [minMax:true, probe: { device, app, events, begin, end -> calc5minAverage(device, app, 'variable', events, begin) }], voltage: [min:0, unit:'V', minMax:true, probe: { device, app, events, begin, end -> calc5minAverage(device, app, 'voltage', events, begin) }], // Non-standard attributes cloudiness: [unit:'%', min:0, max:100, minMax:true, probe: { device, app, events, begin, end -> calc5minAverage(device, app, 'cloudiness', events, begin, true) }], healthStatus: [min:0, max:100, unit:'% online', minMax:false, probe: { device, app, events, begin, end -> calc5minValue(device, 'healthStatus', ['online'], events, begin, end) }], pm10: [unit:'μg/m3', minMax:true, probe: { device, app, events, begin, end -> calc5minAverage(device, app, 'pm10', events, begin, true) }], pm25: [unit:'μg/m3', minMax:true, probe: { device, app, events, begin, end -> calc5minAverage(device, app, 'pm25', events, begin, true) }], vocIndex: [unit:'', minMax:true, probe: { device, app, events, begin, end -> calc5minAverage(device, app, 'vocIndex', events, begin, true) }], windDirection: [unit:'°', min:0, max:360, minMax:true, probe: { device, app, events, begin, end -> calc5minAverage(device, app, 'windDirection', events, begin, true) }], windGust: [unit:'km/h', min:0, minMax:true, probe: { device, app, events, begin, end -> calc5minAverage(device, app, 'windGust', events, begin, true) }], windSpeed: [unit:'km/h', min:0, minMax:true, probe: { device, app, events, begin, end -> calc5minAverage(device, app, 'windSpeed', events, begin, true) }], index: [min:0, unit:'', minMax:false, probe: { device, app, events, begin, end -> calc5minIncrease(device, app, 'index') }], runtime: [min:0, unit:'', minMax:false, probe: { device, app, events, begin, end -> calc5minIncrease(device, app, 'runtime') }], ] // App Identity // =================================================================================================================== definition( name: "${APP_NAME} ${APP_VERSION}", namespace: 'dandanache', author: 'Dan Danache', description: 'Data-Driven Insights for a Smarter Home', documentationLink: 'https://community.hubitat.com/t/release-watchtower-long-term-metrics-app/141505', importUrl: 'https://codeberg.org/dan-danache/hubitat/raw/branch/main/watchtower-app/watchtower.groovy', category: 'Utility', singleInstance: true, installOnOpen: true, iconUrl: '', iconX2Url: '', oauth: true, ) // Standard App Methods // =================================================================================================================== void installed() { log.info "${app.label} has been installed" unschedule() schedule '0 0/5 * ? * * *', 'collectDeviceMetrics' schedule '0 4/5 * ? * * *', 'collectHubMetrics' } void updated() { log.info "${app.label} has been updated" } private void debug(String message) { if (logEnable) log.debug "${APP_NAME} ▸ ${message}" } private void warn(String message) { log.warn "${APP_NAME} ▸ ${message}" } private void error(String message) { log.error "${APP_NAME} ▸ ${message}" } // App Pages // =================================================================================================================== preferences { page name: 'main' page name: 'devices' page name: 'dashboards' page name: 'settings' page name: 'changelog' } Map main() { boolean showInstall = app.installationState == 'INCOMPLETE' return dynamicPage(name:'main', install:true, uninstall:!showInstall) { if (app.installationState != 'COMPLETE') { section { paragraph 'Click the "Done" button to complete the app installation.' } } else { if (!state.accessToken) createAccessToken() // Cleanup devices page state state.remove 'position' state.action = 'list' section { href(name:'devicesLink', title:'Devices', description:'Select devices to monitor', page:'devices', required:false) href(name:'dashboardsLink', title:'Dashboards', description:'Manage dashboards', page:'dashboards', required:false) href(name:'settingsLink', title:'Settings', description:'Configure metrics storage limits', page:'settings', required:false) href(name:'changelogLink', title:'Change log', description:'See latest application changes', url:'https://codeberg.org/dan-danache/hubitat/src/branch/main/watchtower-app/CHANGELOG.md', style:'embedded', state:'complete', required:false) // Preferences input(name:'logEnable', type:'bool', title:'Enable debug logging', defaultValue:false, submitOnChange:true) if (logEnable) { paragraph 'Warning: Enabling debug logging will significantly increase the number of log entries, potentially impacting hub\'s performance.' } } } } } Map devices() { return dynamicPage(name:'devices', title:'Devices', install:false, uninstall:false) { // Highlight and clear last added/viewed position Integer highlightPosition = null if (state.action != 'add') { highlightPosition = state.highlightPosition state.remove 'highlightPosition' } // Render table List devices = collectDeviceConfiguration() String table = '
' devices.each { String deviceName = it[1]?.displayName ?: HUB_NAME table += """ """ } table += '
${renderButton("viewDevice_${it[0]}", "${deviceName}
${it[2].join(', ')}
", 'Edit device configuration', 'view-btn dev-btn')}		 ${it[1]?.displayName ? renderButton("removeDevice_${it[0]}", '🗑️', 'Remove device configuration', 'view-btn dev-btn') : ''}
' section { paragraph """\ ${renderCommonStyle()}${table} """ } // Render add button section { input(name:'addDevice', title:'➕ Add device configuration  ', type:'button') } // Render confirm delete page if (state.action == 'confirm') { DeviceWrapper device = app.getSetting("d.${state.removePosition}") section { paragraph """\
""" } } // Render add/view page if (state.position != null) { DeviceWrapper device = app.getSetting("d.${state.position}") String deviceId = device?.id ?: '0' String deviceName = device?.displayName ?: HUB_NAME List attributes = device ? app.getSetting("a.${state.position}") : HUB_ATTRIBUTES // Render add page if (state.action == 'add') { section { input( name: "d.${state.position}", title: 'Select device', type: 'capability.*', multiple: false, showFilter: true, required: true, submitOnChange: true ) if (device != null) { List allAttr = device.supportedAttributes*.name .findAll { SUPPORTED_ATTRIBUTES.containsKey(it) } .unique() .sort() // Check for device with unsupported attributes if (allAttr.size == 0) { disableSaveButton = true paragraph renderInfoBox("${deviceName} contains no supported attributes. Please select another device!") // Check for duplicate device } else if (devices.any { deviceId == it[1]?.id }) { disableSaveButton = true paragraph renderInfoBox("${deviceName} is already configured. Please select another device!") } else { // Device changed; clear attributes if (attributes != null && !allAttr.containsAll(attributes)) { app.removeSetting "a.${state.position}" app.removeSetting "s.${device.id}" } input( name: "a.${state.position}", title: 'Select attributes', type: 'enum', options: allAttr, multiple: true, required: true, submitOnChange: true ) if (allAttr.contains('switch')) { input( name: "s.${device.id}", title: 'Collect selected attributes, even when the device is turned off', type: 'bool', required: false, defaultValue: false, submitOnChange: true ) } } } } } // Render view page if (state.action == 'view') { section { paragraph """ ${deviceName}${device == null ? '' : "  " } ${device == null ? "
${HUB_ATTRIBUTES.join(', ')}
" : ''} """ if (device != null) { List allAttr = device.supportedAttributes*.name .findAll { SUPPORTED_ATTRIBUTES.containsKey(it) } .unique() .sort() input( name: "a.${state.position}", title: 'Change attributes', type: 'enum', options: allAttr, multiple: true, required: true, submitOnChange: true ) if (allAttr.contains('switch')) { input( name: "s.${device.id}", title: 'Collect selected attributes, even when the device is turned off', type: 'bool', required: false, defaultValue: false, submitOnChange: true ) } } paragraph """ Data files: """ } } section { boolean disableSaveButton = app.getSetting("d.${state.position}") == null || app.getSetting("a.${state.position}") == null paragraph """\
""" } } } } Map dashboards() { List dashboardList = collectDashboards().sort() return dynamicPage(name:'dashboards', title:'Dashboards', install:false, uninstall:false) { String table = renderInfoBox('Click the button below to add your first dashboard') if (dashboardList.size != 0) { table = '
' dashboardList.each { table += """ """ } table += '
${it} ${renderButton("editDashboard_${it}", '✏️', 'Rename', 'view-btn')} ${renderButton("cloneDashboard_${it}", '⿻', 'Clone', 'view-btn')} ${renderButton("removeDashboard_${it}", '🗑️', 'Remove', 'view-btn')}
' } section { paragraph "${renderCommonStyle()}${table}" // input(name:'useCloudLinks', type:'bool', title:'Use cloud links', defaultValue:false, submitOnChange:true) // if (useCloudLinks) { // paragraph 'Warning: Using cloud links will impose a substantial load on your hub resources and the Hubitat cloud services. This is due to metrics data files from the File Manager being proxied through the cloud infrastructure.' // } } // Render add button section { input(name:'addDashboard', title:'➕ Add dashboard   ', type:'button') } // Render add/view page if (state.action == 'add' || state.action == 'edit') { section { input( name: 'dashboardName', title: 'Dashboard name', type: 'text', required: true, submitOnChange: true ) } section { boolean disableSaveButton = app.getSetting('dashboardName') == null || app.getSetting('dashboardName').trim() == '' || dashboardList.contains(app.getSetting('dashboardName')) paragraph """\
""" } } // Render confirm delete page if (state.action == 'confirm') { section { paragraph """\
""" } } } } Map settings() { return dynamicPage(name:'settings', title:'Settings', install:false, uninstall:false) { section('How data collection works', hideable:true, hidden:true) { paragraph '''\ The application utilizes a fixed-size database, similar in design and purpose to an RRD (Round-Robin Database). This setup allows for high-resolution data (minutes per point) to gradually degrade into lower resolutions for long-term retention of historical data.

The following time resolution are used:
  • 5 minutes: Attribute value in the last 5 minutes
  • 1 hour: Average attribute value over the last hour
  • 1 day: Average attribute value over the last day
  • 1 week: Average attribute value over the last week

How it works:
  • Every 5 minutes: The application reads the current value for all configured device attributes and stores this data in the File Manager using CSV files named wt_{device_id}_5m.csv, one file per configured device. Only devices configured in the Devices screen are queried.
  • At the start of every hour: The application reads the data from each device's wt_{device_id}_5m.csv file, selects records from the last hour, calculates the averages, and saves them in CSV files named wt_{device_id}_1h.csv.
  • At midnight daily: The application reads the data from each device's wt_{device_id}_5m.csv file, selects records from the last day (00:00 - 23:59), calculates the averages, and saves them in CSV files named wt_{device_id}_1d.csv.
  • At midnight every Sunday: The application reads the data from each device's wt_{device_id}_1h.csv file, selects records from the last week (Monday 00:00 - Sunday 23:59), calculates the averages, and saves them in CSV files named wt_{device_id}_1w.csv.

To maintain a fixed file size, old records are discarded during each save, as specified below. ''' } section { input( name: 'conf_5MinMaxLines', title: 'Max records with 5 min accuracy
default 864 (3 days), min 288 (1 day)', type: 'number', required: true, defaultValue: 864, range: '288..10000', width: 6, ) input( name: 'conf_1HourMaxLines', title: 'Max records with 1 hour accuracy
default 744 (1 month), min 168 (1 week)', type: 'number', required: true, defaultValue: 744, range: '168..10000', width: 6, ) input( name: 'conf_1DayMaxLines', title: 'Max records with 1 day accuracy
default 732 (2 years), min 366 (1 year)', type: 'number', required: true, defaultValue: 732, range: '366..10000', width: 6, ) input( name: 'conf_1WeekMaxLines', title: 'Max records with 1 week accuracy
default 522 (10 years), min 105 (2 years)', type: 'number', required: true, defaultValue: 522, range: '105..2600', width: 6, ) } section('Advanced settings', hideable:true, hidden:false) { input(name:'collectDisable', type:'bool', title:'Disable data collection (that runs every 5 minutes)', defaultValue:false, submitOnChange:true) if (collectDisable) { paragraph '' } input(name:'aggregateDisable', type:'bool', title:'Disable data aggregation for 1 hour, 1 day, and 1 week intervals', defaultValue:false, submitOnChange:true) if (aggregateDisable) { paragraph '' } } } } // Helper functions // =================================================================================================================== String renderCommonStyle() { return ''' ''' } String renderButton(String name, String label, String tooltip=null, String buttonClass=null, String containerClass=null) { return renderButton(false, name, label, tooltip, buttonClass, containerClass) } String renderButton(Boolean disabled, String name, String label, String tooltip=null, String buttonClass=null, String containerClass=null) { return """
""" } String renderInfoBox(String message) { return "
${message}
" } List collectDeviceConfiguration() { List retVal = [] Integer lastPosition = state.lastPosition ?: 500 for (int position = 1; position <= lastPosition; position++) { // Skip current entry that is in the add form right now if (state.action == 'add' && state.position == position) continue // Skip uncomplete/broken entries if (app.getSetting("d.${position}") == null || app.getSetting("a.${position}") == null) continue retVal.add([position, app.getSetting("d.${position}"), app.getSetting("a.${position}")]) } state.lastPosition = retVal.size == 0 ? 0 : retVal.last()[0] List hubEntry = [0, null, HUB_ATTRIBUTES] return retVal.sort { it[1].label }.plus(0, [hubEntry]) } List collectDashboards() { List retVal = [] state.each { key, val -> if (key.startsWith('g.')) retVal.add(key.substring(2)) } return retVal } String makeDashboardURL(String dashboardName) { String prefix = useCloudLinks == true ? "${apiServerUrl}/${hubUID}/apps/${app.id}" : "${(fullLocalApiServerUrl =~ URL_PATTERN).findAll()[0][1]}" return "${prefix}/watchtower.html?name=${URLEncoder.encode(dashboardName, 'UTF-8')}&access_token=${state.accessToken}" } // Button handler // =================================================================================================================== void appButtonHandler(String buttonName) { List dashboardList = collectDashboards() if (buttonName == 'addDashboard') { app.removeSetting 'dashboardName' state.remove 'dashboardName' state.action = 'add' return } if (buttonName.startsWith('editDashboard_')) { state.dashboardName = buttonName.substring(14) app.updateSetting('dashboardName', state.dashboardName) state.action = 'edit' return } if (buttonName.startsWith('cloneDashboard_')) { state["g.${buttonName.substring(15)} - ${now()}"] = state["g.${buttonName.substring(15)}"] return } if (buttonName == 'saveDashboard') { String newDashboardName = "${app.getSetting('dashboardName')}".trim() if (!dashboardList.contains(newDashboardName)) { String stateEntryName = "g.${state.dashboardName}" state["g.${newDashboardName}"] = state[stateEntryName] ?: '{"panels":[]}' state.remove stateEntryName } app.removeSetting 'dashboardName' state.remove 'dashboardName' state.action = 'list' return } if (buttonName.startsWith('removeDashboard_')) { state.dashboardName = buttonName.substring(16) state.action = 'confirm' return } if (buttonName == 'removeDashboard') { String stateEntryName = "g.${state.dashboardName}" state.remove stateEntryName state.remove 'dashboardName' state.action = 'list' return } if (buttonName == 'addDevice') { // Find next empty position for insertion int nextPosition = 1 while (app.getSetting("d.${nextPosition}") != null && app.getSetting("a.${nextPosition}") != null) { nextPosition++ } state.position = nextPosition // Clear form app.removeSetting "d.${nextPosition}" app.removeSetting "a.${nextPosition}" // Update action state.action = 'add' return } if (buttonName.startsWith('viewDevice_')) { state.position = Integer.parseInt(buttonName.substring(11)) state.highlightPosition = state.position state.action = 'view' return } if (buttonName.startsWith('removeDevice_')) { state.removePosition = Integer.parseInt(buttonName.substring(13)) state.action = 'confirm' return } if (buttonName == 'removeDevice') { // Remove CSV files DeviceWrapper device = app.getSetting("d.${state.removePosition}") deleteDataFiles(device) // Cleanup settings app.removeSetting "s.${device.id}" app.removeSetting "d.${state.removePosition}" app.removeSetting "a.${state.removePosition}" // Reset lastPosition; to be calculated on next list render state.remove 'lastPosition' // Update action state.remove 'removePosition' state.action = 'list' return } if (buttonName == 'cancel') { // Clear form if (state.action == 'add') { app.removeSetting "s.${app.getSetting("d.${state.position}")?.id}" app.removeSetting "d.${state.position}" app.removeSetting "a.${state.position}" } // Update action state.remove 'position' state.remove 'removePosition' state.action = 'list' return } if (buttonName == 'saveDevice' || buttonName == 'close') { // Update lastPosition && highlightPosition state.lastPosition = Math.max(state.position, state.lastPosition) state.highlightPosition = state.position // Update action state.remove 'position' state.action = 'list' } } // Metrics handlers // =================================================================================================================== @CompileStatic static String calc5minValue(DeviceWrapper device, String attribute, List onValues, List events, long beginTimestamp, long endTimestamp) { String currentValue = device.currentValue(attribute) if (currentValue == null) return '' // Short-circuit all the time calculations if nothing happened in the past 5 minutes if (events.size() == 0) return onValues.contains(currentValue) ? '100' : '0' long onTime = 0 long lastOnTimestamp = beginTimestamp for (int i = 0; i < events.size(); i++) { Event event = events.get(i) if (event.name != attribute || !event.isStateChange) continue long eventTimeStamp = event.date.time if (eventTimeStamp < beginTimestamp || eventTimeStamp > endTimestamp) continue if (onValues.contains(event.value)) { lastOnTimestamp = eventTimeStamp continue } else { onTime += eventTimeStamp - lastOnTimestamp } } if (onValues.contains(currentValue)) onTime += endTimestamp - lastOnTimestamp return new BigDecimal(onTime / 3000.0d).setScale(2, RoundingMode.HALF_UP).stripTrailingZeros().toPlainString() } @CompileStatic static String calc5minIncrease(DeviceWrapper device, InstalledAppWrapper app, String attribute) { String currentValue = device.currentValue(attribute) if (currentValue == null) return '' String stateKey = String.format('v.%s_%s', device.id, attribute) String lastValue = app.state.get(stateKey) ?: currentValue app.state.put(stateKey, currentValue) BigDecimal increase = new BigDecimal(currentValue) - new BigDecimal(lastValue) if (increase < 0) increase = new BigDecimal(currentValue) // Device reset; counter starting back at zero return increase.setScale(2, RoundingMode.HALF_UP).stripTrailingZeros().toPlainString() } @CompileStatic static String calc5minAverage(DeviceWrapper device, InstalledAppWrapper app, String attribute, List events, long beginTimestamp, boolean nullIfOff = false) { if (nullIfOff == true && device.currentValue('switch') == 'off' && app.getSetting("s.${device.id}") != true) return '' String currentValue = device.currentValue(attribute) if (currentValue == null) return '' BigDecimal sum = BigDecimal.ZERO int count = 0 for (int i = 0; i < events.size(); i++) { Event event = events.get(i) if (event.name != attribute || !event.isStateChange) continue long eventTimeStamp = event.date.time if (eventTimeStamp < beginTimestamp) continue sum += new BigDecimal(event.value) count++ } sum += new BigDecimal(currentValue) return (sum / (count + 1)).setScale(2, RoundingMode.HALF_UP).stripTrailingZeros().toPlainString() } void collectHubMetrics() { if (logEnable) debug 'Start saving hub metrics to state (to be collected in 1 minute) ...' state.remove 'hubTemperature' state.remove 'hubDatabaseSize' state.remove 'hubRAM' state.remove 'hubCPU' fetchHubUrl('/hub/advanced/internalTempCelsius') { state.hubTemperature = convertTemperatureIfNeeded(new BigDecimal(it), 'C', 1) } fetchHubUrl('/hub/advanced/databaseSize') { state.hubDatabaseSize = new BigDecimal(it).setScale(2, RoundingMode.HALF_UP).stripTrailingZeros().toPlainString() } fetchHubUrl('/hub/advanced/freeOSMemoryLast') { String[] bits = it.split(',') state.hubRAM = (new BigDecimal(bits[3]) / 1024).setScale(2, RoundingMode.HALF_UP).stripTrailingZeros().toPlainString() state.hubCPU = (new BigDecimal(bits[4]) * 25).setScale(2, RoundingMode.HALF_UP).stripTrailingZeros().toPlainString() } } void fetchHubUrl(String path, Closure func) { httpGet("http://127.0.0.1:8080${path}") { if (it.status != 200) { warn "Failed to fetch hub resource: ${path}" return } func("${it.data}") } } void collectDeviceMetrics() { if (collectDisable == true) return ZonedDateTime now = ZonedDateTime.now(ZoneId.of(location.timeZone.ID)).withSecond(0).withNano(0) if (logEnable) debug "Collecting device metrics: now=${now}, epoch=${now.toEpochSecond()}, dow=${now.dayOfWeek}, hour=${now.hour}, min=${now.minute}" collectDeviceConfiguration().each { conf -> DeviceWrapper device = conf[1] List attrs = conf[2] String deviceId = device?.id ?: '0' try { update5MinData(now, device, attrs) } catch (Exception ex) { error "Failed to update5MinData for device #${deviceId}: ${ex.message}" } if (aggregateDisable == true) return if (now.minute != 0) return try { update1HourData(now, deviceId, attrs) } catch (Exception ex) { error "Failed to update1HourData for device #${deviceId}: ${ex.message}" } if (now.hour != 0) return try { update1DayData(now, deviceId, attrs) } catch (Exception ex) { error "Failed to update1DayData for device #${deviceId}: ${ex.message}" } if (now.dayOfWeek != DayOfWeek.MONDAY) return try { update1WeekData(now, deviceId, attrs) } catch (Exception ex) { error "Failed to update1WeekData for device #${deviceId}: ${ex.message}" } } } void update5MinData(ZonedDateTime now, DeviceWrapper device, List attrs, int lookbackMinutes = 5) { String deviceId = device?.id ?: '0' Date beginDate = Date.from(now.minusMinutes(lookbackMinutes).toInstant()) List events = lookbackMinutes == 0 ? [] : (device?.eventsSince(beginDate) ?: []).sort { it.date } if (logEnable) debug "Updating 5 min metrics for device #${deviceId}, events=${events.collect { "${it.name}=${it.value}@${it.date}" }} ..." // Compute and save a new CSV record List newCsvRecord = ["${now.toEpochSecond()}"] attrs.each { String value = SUPPORTED_ATTRIBUTES[it].probe(device, app, events, beginDate.time, now.toInstant().toEpochMilli()) newCsvRecord.add(value) } appendDataRecord("wt_${deviceId}_5m.csv", newCsvRecord, attrs, conf_5MinMaxLines ?: 864, false) } void update1HourData(ZonedDateTime now, String deviceId, List attrs) { if (logEnable) debug "Updating 1 hour metrics device #${deviceId} ..." // Compute averages from lower interval file String lowerFileName = "wt_${deviceId}_5m.csv" Long onlyAfter = now.minusHours(1).toEpochSecond() try { String lowerFileContents = new String(downloadHubFile(lowerFileName), 'UTF-8') String[] averagesAndMinMax = computeAveragesAndMinMax(lowerFileContents, attrs, onlyAfter) if (averagesAndMinMax.length == 0) { warn 'Could not compute 1 hour averages and min/max' return } // Create and save a new CSV record List newCsvRecord = ["${now.toEpochSecond()}"] for (int i = 0; i < averagesAndMinMax.length; i++) { newCsvRecord.add(averagesAndMinMax[i]) } appendDataRecord("wt_${deviceId}_1h.csv", newCsvRecord, attrs, conf_1HourMaxLines ?: 744, true) } catch (NoSuchFileException ex) { warn "update1HourData: File not found: ${lowerFileName}" } } void update1DayData(ZonedDateTime now, String deviceId, List attrs) { if (logEnable) debug "Updating 1 day metrics device #${deviceId} ..." // Compute averages and min/max from lower interval file String lowerFileName = "wt_${deviceId}_5m.csv" Long onlyAfter = now.minusDays(1).toEpochSecond() try { String lowerFileContents = new String(downloadHubFile(lowerFileName), 'UTF-8') String[] averagesAndMinMax = computeAveragesAndMinMax(lowerFileContents, attrs, onlyAfter) if (averagesAndMinMax.length == 0) { warn 'Could not compute 1 day averages and min/max' return } // Create and save a new CSV record List newCsvRecord = ["${now.toEpochSecond()}"] for (int i = 0; i < averagesAndMinMax.length; i++) { newCsvRecord.add(averagesAndMinMax[i]) } appendDataRecord("wt_${deviceId}_1d.csv", newCsvRecord, attrs, conf_1DayMaxLines ?: 732, true) } catch (NoSuchFileException ex) { warn "update1DayData: File not found: ${lowerFileName}" } } void update1WeekData(ZonedDateTime now, String deviceId, List attrs) { if (logEnable) debug "Updating 1 week metrics device #${deviceId} ..." // Compute averages and min/max from lower interval file String lowerFileName = "wt_${deviceId}_1h.csv" Long onlyAfter = now.minusWeeks(1).toEpochSecond() try { String lowerFileContents = new String(downloadHubFile(lowerFileName), 'UTF-8') String[] averagesAndMinMax = computeAveragesAndMinMax(lowerFileContents, attrs, onlyAfter) if (averagesAndMinMax.length == 0) { warn 'Could not compute 1 week averages and min/max' return } // Create and save a new CSV record List newCsvRecord = ["${now.toEpochSecond()}"] for (int i = 0; i < averagesAndMinMax.length; i++) { newCsvRecord.add(averagesAndMinMax[i]) } appendDataRecord("wt_${deviceId}_1w.csv", newCsvRecord, attrs, conf_1WeekMaxLines ?: 522, true) } catch (NoSuchFileException ex) { warn "update1DayData: File not found: ${lowerFileName}" } } // Datastore helpers // =================================================================================================================== void safeUploadHubFile(String fileName, byte[] bytes) { int retryCount = 0 boolean success = false for (int i = 1; i <= 3; i++) { try { uploadHubFile(fileName, bytes) return } catch (Exception ex) { log.warn "Failed to upload ${fileName}: ${ex.message}. Retrying (${i} / 3) ..." pauseExecution(500) } } log.error "Failed to upload ${fileName} after 3 attempts - possible data loss" } void appendDataRecord(String fileName, List csvRecord, List attrs, Long maxLines, boolean minMaxHeaders) { if (logEnable) debug "appendDataRecord(fileName=${fileName}, csvRecord=${csvRecord}, attrs=${attrs}, maxLines=${maxLines}, minMaxHeaders=${minMaxHeaders})" List csvLines = [] csvLines.add("timestamp,${attrs.join(',')}${minMaxHeaders ? ",${attrs.join('_min,')}_min,${attrs.join('_max,')}_max" : ''}") csvLines.addAll(loadDataLines(fileName, attrs, minMaxHeaders, maxLines - 1)) csvLines.add("${csvRecord.join(',')}") safeUploadHubFile(fileName, csvLines.join('\n').replaceAll(',null', ',').bytes) } List loadDataLines(String fileName, List attrs, boolean minMaxHeaders, Long maxLines) { try { List lines = new String(downloadHubFile(fileName), 'UTF-8').trim().split('\n') if (lines.size() < 2) return [] List oldAttrs = lines.get(0).split(',', -1).drop(1).findAll { !it.endsWith('_min') && !it.endsWith('_max') } List dataLines = lines.drop(1).takeRight((int) maxLines) // Attributes did not change return attrs.containsAll(oldAttrs) && attrs.size() == oldAttrs.size() ? dataLines : patchDataLines(dataLines, oldAttrs, attrs, minMaxHeaders) } catch (NoSuchFileException ex) { warn "Creating data file: ${fileName}" return [] } } List patchDataLines(List oldLines, List oldAttrs, List newAttrs, boolean minMaxHeaders) { warn "Monitored attributes changed from ${oldAttrs} to ${newAttrs}. Migrating data file ..." int oldAttrsLen = oldAttrs.size() int newAttrsLen = newAttrs.size() List newLines = [] List idxs = newAttrs.collect { oldAttrs.indexOf(it) } oldLines.each { String[] vals = it.split(',', -1) // Init newline and copy timestamp from/to position 0 String[] newLine = new String[1 + newAttrs.size() * (minMaxHeaders ? 3 : 1)] newLine[0] = vals[0] // Process each attribute for (int i = 0; i < newAttrsLen; i++) { int idx = idxs.get(i) String val = '', min = '', max = '' // Copy value from its old position to the new position if (idx != -1) { val = vals[1 + idx] if (minMaxHeaders && vals.length > 1 + oldAttrsLen + idx) min = vals[1 + oldAttrsLen + idx] if (minMaxHeaders && vals.length > 1 + 2 * oldAttrsLen + idx) min = vals[1 + 2 * oldAttrsLen + idx] } newLine[1 + i] = val if (minMaxHeaders) { newLine[1 + newAttrsLen + i] = min newLine[1 + 2 * newAttrsLen + i] = max } } newLines.add(newLine.join(',')) } return newLines } @CompileStatic String[] computeAveragesAndMinMax(String fileContents, List attrs, Long onlyAfter) { if (fileContents == null) return new String[0] String[] fileLines = fileContents.trim().split('\n') if (fileLines.length < 2) return new String[0] // // Sanity check; do we need this? // int attrsCount = attrs.size() // if (fileLines[0].split(',').length < attrsCount + 1) { // warn "Sanity check failed: ${fileLines[0].split(',').length} != ${attrsCount + 1}" // return null // } // Init result int attrsCount = attrs.size() BigDecimal[] sums = new BigDecimal[attrsCount] BigDecimal[] cnts = new BigDecimal[attrsCount] Boolean[] minMax = new Boolean[attrsCount] BigDecimal[] mins = new BigDecimal[attrsCount] BigDecimal[] maxs = new BigDecimal[attrsCount] for (int i = 0; i < attrsCount; i++) { sums[i] = BigDecimal.ZERO cnts[i] = BigDecimal.ZERO minMax[i] = (Boolean) SUPPORTED_ATTRIBUTES.get(attrs.get(i)).get('minMax') } // Parse only records of interest (starting from the end of the file, and skipping first line) and calculate their sums and counts for (int i = fileLines.length - 1; i > 0; i--) { String[] rowElements = fileLines[i].split(',', -1) if (Long.parseLong(rowElements[0]) <= onlyAfter) break for (int j = 0; j < attrsCount; j++) { if (rowElements[1 + j] == '' || rowElements[1 + j] == '-') continue BigDecimal val = new BigDecimal(rowElements[1 + j]) sums[j] += val; cnts[j] += 1 if (!minMax[j]) continue BigDecimal min = rowElements.length > 1 + attrsCount + j ? new BigDecimal(rowElements[1 + attrsCount + j]) : val BigDecimal max = rowElements.length > 1 + 2 * attrsCount + j ? new BigDecimal(rowElements[1 + 2 * attrsCount + j]) : val mins[j] = mins[j] == null ? min : (mins[j] > min ? min : mins[j]) maxs[j] = maxs[j] == null ? max : (maxs[j] < max ? max : maxs[j]) } } debug "Records of interest: sums=${sums}, cnts=${cnts}, mins=${mins}, maxs=${maxs}" // Divide sums by cnts to get the averages; exception is the counter-like attributes, that are ever-increasing String[] newRecord = new String[3 * attrsCount] for (int i = 0; i < attrsCount; i++) { if (attrs.get(i) == 'energy' || attrs.get(i) == 'index' || attrs.get(i) == 'runtime') { newRecord[i] = cnts[i] == 0 ? '' : sums[i].setScale(2, RoundingMode.HALF_UP).stripTrailingZeros().toPlainString() } else { newRecord[i] = cnts[i] == 0 ? '' : (sums[i] / cnts[i]).setScale(2, RoundingMode.HALF_UP).stripTrailingZeros().toPlainString() } newRecord[attrsCount + i] = mins[i] == null ? '' : mins[i].setScale(2, RoundingMode.HALF_UP).stripTrailingZeros().toPlainString() newRecord[2 * attrsCount + i] = maxs[i] == null ? '' : maxs[i].setScale(2, RoundingMode.HALF_UP).stripTrailingZeros().toPlainString() } debug "New record with min/max: ${newRecord}" return newRecord } void deleteDataFiles(DeviceWrapper device) { if (device == null) return warn "Deleting data files for ${device} (${device.id})" try { deleteHubFile("wt_${device.id}_5m.csv") } catch (NoSuchFileException ex) { debug "File wt_${device.id}_5m.csv not found" } try { deleteHubFile("wt_${device.id}_1h.csv") } catch (NoSuchFileException ex) { debug "File wt_${device.id}_1h.csv not found" } try { deleteHubFile("wt_${device.id}_1d.csv") } catch (NoSuchFileException ex) { debug "File wt_${device.id}_1d.csv not found" } try { deleteHubFile("wt_${device.id}_1w.csv") } catch (NoSuchFileException ex) { debug "File wt_${device.id}_1w.csv not found" } // Also cleanup app state entries used for counter attributes (e.g. energy, index, runtime) // @see calc5minIncrease() state.entrySet().removeIf { it.key.startsWith("v.${device.id}_") } } // Implement Mappings // =================================================================================================================== mappings { path('/watchtower.html') { action:[GET:'getDashboardHtmlMapping'] } path('/watchtower.js') { action:[GET:'getDashboardJsMapping'] } path('/watchtower.csv') { action:[GET:'getDashboardCsvMapping'] } path('/icon.png') { action:[GET:'getIconMapping'] } path('/app.webmanifest') { action:[GET:'getAppManifestMapping'] } path('/grid-layout.json') { action:[GET:'getGridLayoutMapping', PUT:'putGridLayoutMapping'] } path('/monitored-devices.json') { action:[GET:'getMonitoredDevicesMapping'] } path('/supported-attributes.json') { action:[GET:'getSupportedAttributesMapping'] } path('/hub-info.json') { action:[GET:'getHubInfoMapping'] } path('/collect-device-metrics') { action:[GET:'getCollectDeviceMetricsMapping'] } } Map getDashboardHtmlMapping() { if (logEnable) debug "Proxying watchtower.html to ${request.HOST} (${request.requestSource})" if (params.name == null) throw new RuntimeException('Missing "name" query param') return render(status:200, contentType:'text/html', data: new String(downloadHubFile('watchtower.html'), 'UTF-8') .replaceAll('\\$\\{access_token\\}', "${state.accessToken}") .replaceAll('\\$\\{dashboard_name\\}', "${params.name}") ) } Map getDashboardJsMapping() { if (logEnable) debug "Proxying watchtower.js to ${request.HOST} (${request.requestSource})" if (request.requestSource == 'cloud') return render(status:301, headers:[location:'https://codeberg.org/dan-danache/hubitat/raw/branch/main/watchtower-app/watchtower.js']) return render(status:200, contentType:'text/javascript', data:new String(downloadHubFile('watchtower.js'), 'UTF-8')) } Map getDashboardCsvMapping() { if (logEnable) debug "Proxying CSV data file: device=${params.device}, precision=${params.precision}" if (params.device == null) throw new RuntimeException('Missing "device" query param') if (params.precision == null) throw new RuntimeException('Missing "precision" query param') return render(status:200, contentType:'text/csv', data: new String(downloadHubFile("wt_${params.device}_${params.precision}.csv"), 'UTF-8') ) } Map getIconMapping() { return render(status:200, contentType:'image/png', data:APP_ICON.decodeBase64()) } Map getAppManifestMapping() { if (logEnable) debug "Returning PWA manifest for dashboard: ${params.name}" if (params.name == null) throw new RuntimeException('Missing "name" query param') return render(status:200, contentType:'application/manifest+json', data: """\ { "id": "${UUID.nameUUIDFromBytes(params.name.bytes)}", "name": "${params.name}", "short_name": "${params.name}", "description": "View metrics for your smart devices.", "start_url": "${makeDashboardURL(params.name)}", "icons": [{ "src": "data:image/png;base64,${MASKABLE_ICON}", "sizes": "512x512", "type": "image/png", "purpose": "maskable" },{ "src": "data:image/png;base64,${APP_ICON}", "sizes": "512x512", "type": "image/png" }], "categories": ["utilities"], "display": "standalone", "orientation": "any", "theme_color": "${params.theme == 'dark' ? '#1b1b1b' : '#eee8d5'}", "background_color": "${params.theme == 'dark' ? '#1b1b1b' : '#eee8d5'}" } """ ) } Map getGridLayoutMapping() { if (logEnable) debug "Returning grid layout for dashboard: ${params.name}" if (params.name == null) throw new RuntimeException('Missing "name" query param') String stateEntryName = "g.${params.name}" String layout = state[stateEntryName] if (layout == null) return render(status:200, contentType:'application/json', data:'{"status": false}') return render(status:200, contentType:'application/json', data:layout) } Map putGridLayoutMapping() { if (logEnable) debug "Saving grid layout for dashboard: ${params.name}" if (params.name == null) throw new RuntimeException('Missing "name" query param') String stateEntryName = "g.${params.name}" if (!state[stateEntryName]) return render(status:200, contentType:'application/json', data:'{"status": false}') runIn(1, 'saveGridLayout', [data: [stateEntryName:stateEntryName, json:"${request.body}"]]) return render(status:200, contentType:'application/json', data:'{"status": true}') } Map saveGridLayout(Map data) { state[data.stateEntryName] = data.json return render(status:200, contentType:'application/json', data:'{"status": true}') } Map getMonitoredDevicesMapping() { if (logEnable) debug 'Returning monitored devices list' List devices = collectDeviceConfiguration().collect { return [id:it[1]?.id ?: '0', name:it[1]?.displayName ?: HUB_NAME, attrs:it[2]] } return render(status:200, contentType:'application/json', data:new JsonBuilder(devices).toString()) } Map getSupportedAttributesMapping() { if (logEnable) debug 'Returning supported attributes list' Map attributes = SUPPORTED_ATTRIBUTES.collectEntries { key, val -> [key, val.findAll { k, v -> k != 'probe' }] } if (location.temperatureScale == 'F') { // https://www.urbandictionary.com/define.php?term=Retard%20Unit attributes.each { key, val -> if (val.unit == '°C') val.unit = '°F' if (val.unit == 'km/h') val.unit = 'mph' } } return render(status:200, contentType:'application/json', data:new JsonBuilder(attributes).toString()) } Map getHubInfoMapping() { if (logEnable) debug 'Returning Hub information' return render(status:200, contentType:'application/json', data: """\ { "name": "${location.hub.name}", "ip": "${location.hub.localIP}", "uptime": ${location.hub.uptime.toLong()}, "model": "${hubVersion}", "fw": "${location.hub.firmwareVersionString}", "cpu": "${state.hubCPU ?: '--'}%", "ram": "${state.hubRAM ?: '--'} MB free", "temp": "${state.hubTemperature ?: '--'}°${location.temperatureScale}", "db": "${state.hubDatabaseSize ?: '--'} MB" } """ ) } Map getCollectDeviceMetricsMapping() { ZonedDateTime now = ZonedDateTime.now(ZoneId.of(location.timeZone.ID)).withNano(0) int lookbackMinutes = params.lookbackMinutes ? Integer.parseInt(params.lookbackMinutes) : 0 lookbackMinutes = lookbackMinutes < 0 ? 0 : (lookbackMinutes > 30 ? 30 : lookbackMinutes) if (logEnable) debug "Collecting device metrics (on-demand): lookback=${lookbackMinutes}min now=${now}, epoch=${now.toEpochSecond()}" collectDeviceConfiguration().each { conf -> DeviceWrapper device = conf[1] List attrs = conf[2] String deviceId = device?.id ?: '0' try { update5MinData(now, device, attrs, lookbackMinutes) } catch (Exception ex) { error "Failed to collect metrics for device #${deviceId}: ${ex.message}" } } return render(status:200, contentType:'application/json', data:'{"status": "Done"}') }