├── oras_dsh.h ├── README.md ├── template-filters.txt ├── LICENSE └── esphome-bathroom.yaml /oras_dsh.h: -------------------------------------------------------------------------------- 1 | #include "esphome.h" 2 | using namespace esphome; 3 | 4 | class DSH { 5 | public: 6 | 7 | unsigned long tStartTime; 8 | unsigned long tLastUpdate; 9 | 10 | char szLastShowerEnded[32]; // Human readable of tLastUpdate 11 | 12 | unsigned long lCurrentShowerNo; // 13 | unsigned long lLastShowerNo; // No of previous shower - used to find out if previous shower is being continued 14 | 15 | float curWaterLiters; 16 | float curEnergy; 17 | float curBathTemp; 18 | uint16_t curShowerFlowDuration; 19 | 20 | float lastWaterLiters=0; 21 | float lastEnergy=0; 22 | float lastBathTemp=0; 23 | uint16_t lastShowerFlowDuration; 24 | 25 | unsigned long lastShowerDuration=0; 26 | 27 | bool occupancy=0; 28 | 29 | uint8_t bleData[20]; 30 | 31 | } dsh; 32 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # oras-shower 2 | ESPhome code get grab data out of a Oras Hydractiva Digital shower head 3 | 4 | I am not sure if the service and characteritics uid are the same for all shower heads. 5 | 6 | You will need to set the MAC address of the shower head, and if the shower head cannot be found, the service and characteristics uid's must be located. 7 | For that purpose, I used nRF connect on my Android phone. 8 | If the shower head cannot be found, let me know - and I will try to cook up a description on how to locate the uid's 9 | 10 | Sensors are only updated when water is flowing through the shower head (and ESPhome has sufficient time to connect and fetch data). When active, the sensors are updated every 5 seconds.. 11 | 12 | Sensor output (example): 13 | 14 | ![image](https://user-images.githubusercontent.com/8531428/211394034-c58902ec-b5b6-430a-81c2-8d3a6c9a9a08.png) 15 | 16 | Once a shower has been detected/assumed finished, the "current" readings are moved to the "last" readings, and the "current" are reset to "Unknown" (until next shower starts). 17 | 18 | ![image](https://user-images.githubusercontent.com/8531428/211408135-4361e846-900c-4552-8ee0-ccd52b9efe2e.png) 19 | 20 | The shower head is this one: https://info.oras.com/en/oras-hydractiva-digital 21 | 22 | In the yaml file, you will have to set the right MAC address of your shower head (in the ble_client section). 23 | 24 | If you have difficulties finding the MAC address, try to enable DEBUG logging - then it will show whatever BLE devices, that is found with the name "DHS", and the associated Service UUID (used in line 322) 25 | 26 | If you don't want the "last" sensors to go in state unknown or unavailable if the ESP device reboots or similar, you need to filter the appropriate sensors - for example by adding the content from template-filters.txt to the "template:" section of your configuration.yaml file. 27 | -------------------------------------------------------------------------------- /template-filters.txt: -------------------------------------------------------------------------------- 1 | - sensor: 2 | - unique_id: 'dsh_lastshowerkwh_f' 3 | state: > 4 | {% if states('sensor.dsh_lastshowerkwh') not in ['unavailable','unknown'] %} 5 | {{ states('sensor.dsh_lastshowerkwh') }} 6 | {% else %} 7 | {{ this.state }} 8 | {% endif %} 9 | device_class: energy 10 | unit_of_measurement: "kWh" 11 | 12 | - sensor: 13 | - unique_id: 'dsh_lastshowertemp_f' 14 | state: > 15 | {% if states('sensor.dsh_lastshowertemp') not in ['unavailable','unknown'] %} 16 | {{ states('sensor.dsh_lastshowertemp') }} 17 | {% else %} 18 | {{ this.state }} 19 | {% endif %} 20 | device_class: temperature 21 | unit_of_measurement: "°C" 22 | 23 | - sensor: 24 | - unique_id: 'dsh_lastdurationseconds_f' 25 | state: > 26 | {% if states('sensor.dsh_lastdurationseconds') not in ['unavailable','unknown'] %} 27 | {{ states('sensor.dsh_lastdurationseconds') }} 28 | {% else %} 29 | {{ this.state }} 30 | {% endif %} 31 | unit_of_measurement: "s" 32 | 33 | - sensor: 34 | - unique_id: 'sensor.dsh_lastshowerliter_f' 35 | state: > 36 | {% if states('sensor.dsh_lastshowerliter') not in ['unavailable','unknown'] %} 37 | {{ states('sensor.dsh_lastshowerliter') }} 38 | {% else %} 39 | {{ this.state }} 40 | {% endif %} 41 | device_class: water 42 | unit_of_measurement: "L" 43 | 44 | - sensor: 45 | - unique_id: 'dsh_lastshowerm3_f' 46 | state: > 47 | {% if states('sensor.dsh_lastshowerm3') not in ['unavailable','unknown'] %} 48 | {{ states('sensor.dsh_lastshowerm3') }} 49 | {% else %} 50 | {{ this.state }} 51 | {% endif %} 52 | device_class: water 53 | unit_of_measurement: "m³" 54 | 55 | - sensor: 56 | - unique_id: 'dsh_lastshowerfinished_f' 57 | state: > 58 | {% if states('sensor.dsh_lastshowerfinished') not in ['unavailable','unknown'] %} 59 | {{ states('sensor.dsh_lastshowerfinished') }} 60 | {% else %} 61 | {{ this.state }} 62 | {% endif %} 63 | icon: 'mdi:timer' 64 | 65 | - binary_sensor: 66 | - unique_id: 'dsh_showeroccupied_f' 67 | state: > 68 | {% if states('binary_sensor.dsh_showeroccupied') not in ['unavailable','unknown'] %} 69 | {{ states('binary_sensor.dsh_showeroccupied') }} 70 | {% else %} 71 | {{ this.state }} 72 | {% endif %} 73 | device_class: occupancy 74 | icon: 'mdi:shower-head' 75 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 2, June 1991 3 | 4 | Copyright (C) 1989, 1991 Free Software Foundation, Inc., 5 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 6 | Everyone is permitted to copy and distribute verbatim copies 7 | of this license document, but changing it is not allowed. 8 | 9 | Preamble 10 | 11 | The licenses for most software are designed to take away your 12 | freedom to share and change it. By contrast, the GNU General Public 13 | License is intended to guarantee your freedom to share and change free 14 | software--to make sure the software is free for all its users. This 15 | General Public License applies to most of the Free Software 16 | Foundation's software and to any other program whose authors commit to 17 | using it. (Some other Free Software Foundation software is covered by 18 | the GNU Lesser General Public License instead.) You can apply it to 19 | your programs, too. 20 | 21 | When we speak of free software, we are referring to freedom, not 22 | price. Our General Public Licenses are designed to make sure that you 23 | have the freedom to distribute copies of free software (and charge for 24 | this service if you wish), that you receive source code or can get it 25 | if you want it, that you can change the software or use pieces of it 26 | in new free programs; and that you know you can do these things. 27 | 28 | To protect your rights, we need to make restrictions that forbid 29 | anyone to deny you these rights or to ask you to surrender the rights. 30 | These restrictions translate to certain responsibilities for you if you 31 | distribute copies of the software, or if you modify it. 32 | 33 | For example, if you distribute copies of such a program, whether 34 | gratis or for a fee, you must give the recipients all the rights that 35 | you have. You must make sure that they, too, receive or can get the 36 | source code. And you must show them these terms so they know their 37 | rights. 38 | 39 | We protect your rights with two steps: (1) copyright the software, and 40 | (2) offer you this license which gives you legal permission to copy, 41 | distribute and/or modify the software. 42 | 43 | Also, for each author's protection and ours, we want to make certain 44 | that everyone understands that there is no warranty for this free 45 | software. If the software is modified by someone else and passed on, we 46 | want its recipients to know that what they have is not the original, so 47 | that any problems introduced by others will not reflect on the original 48 | authors' reputations. 49 | 50 | Finally, any free program is threatened constantly by software 51 | patents. We wish to avoid the danger that redistributors of a free 52 | program will individually obtain patent licenses, in effect making the 53 | program proprietary. To prevent this, we have made it clear that any 54 | patent must be licensed for everyone's free use or not licensed at all. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | GNU GENERAL PUBLIC LICENSE 60 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 61 | 62 | 0. This License applies to any program or other work which contains 63 | a notice placed by the copyright holder saying it may be distributed 64 | under the terms of this General Public License. The "Program", below, 65 | refers to any such program or work, and a "work based on the Program" 66 | means either the Program or any derivative work under copyright law: 67 | that is to say, a work containing the Program or a portion of it, 68 | either verbatim or with modifications and/or translated into another 69 | language. (Hereinafter, translation is included without limitation in 70 | the term "modification".) Each licensee is addressed as "you". 71 | 72 | Activities other than copying, distribution and modification are not 73 | covered by this License; they are outside its scope. The act of 74 | running the Program is not restricted, and the output from the Program 75 | is covered only if its contents constitute a work based on the 76 | Program (independent of having been made by running the Program). 77 | Whether that is true depends on what the Program does. 78 | 79 | 1. You may copy and distribute verbatim copies of the Program's 80 | source code as you receive it, in any medium, provided that you 81 | conspicuously and appropriately publish on each copy an appropriate 82 | copyright notice and disclaimer of warranty; keep intact all the 83 | notices that refer to this License and to the absence of any warranty; 84 | and give any other recipients of the Program a copy of this License 85 | along with the Program. 86 | 87 | You may charge a fee for the physical act of transferring a copy, and 88 | you may at your option offer warranty protection in exchange for a fee. 89 | 90 | 2. You may modify your copy or copies of the Program or any portion 91 | of it, thus forming a work based on the Program, and copy and 92 | distribute such modifications or work under the terms of Section 1 93 | above, provided that you also meet all of these conditions: 94 | 95 | a) You must cause the modified files to carry prominent notices 96 | stating that you changed the files and the date of any change. 97 | 98 | b) You must cause any work that you distribute or publish, that in 99 | whole or in part contains or is derived from the Program or any 100 | part thereof, to be licensed as a whole at no charge to all third 101 | parties under the terms of this License. 102 | 103 | c) If the modified program normally reads commands interactively 104 | when run, you must cause it, when started running for such 105 | interactive use in the most ordinary way, to print or display an 106 | announcement including an appropriate copyright notice and a 107 | notice that there is no warranty (or else, saying that you provide 108 | a warranty) and that users may redistribute the program under 109 | these conditions, and telling the user how to view a copy of this 110 | License. (Exception: if the Program itself is interactive but 111 | does not normally print such an announcement, your work based on 112 | the Program is not required to print an announcement.) 113 | 114 | These requirements apply to the modified work as a whole. If 115 | identifiable sections of that work are not derived from the Program, 116 | and can be reasonably considered independent and separate works in 117 | themselves, then this License, and its terms, do not apply to those 118 | sections when you distribute them as separate works. But when you 119 | distribute the same sections as part of a whole which is a work based 120 | on the Program, the distribution of the whole must be on the terms of 121 | this License, whose permissions for other licensees extend to the 122 | entire whole, and thus to each and every part regardless of who wrote it. 123 | 124 | Thus, it is not the intent of this section to claim rights or contest 125 | your rights to work written entirely by you; rather, the intent is to 126 | exercise the right to control the distribution of derivative or 127 | collective works based on the Program. 128 | 129 | In addition, mere aggregation of another work not based on the Program 130 | with the Program (or with a work based on the Program) on a volume of 131 | a storage or distribution medium does not bring the other work under 132 | the scope of this License. 133 | 134 | 3. You may copy and distribute the Program (or a work based on it, 135 | under Section 2) in object code or executable form under the terms of 136 | Sections 1 and 2 above provided that you also do one of the following: 137 | 138 | a) Accompany it with the complete corresponding machine-readable 139 | source code, which must be distributed under the terms of Sections 140 | 1 and 2 above on a medium customarily used for software interchange; or, 141 | 142 | b) Accompany it with a written offer, valid for at least three 143 | years, to give any third party, for a charge no more than your 144 | cost of physically performing source distribution, a complete 145 | machine-readable copy of the corresponding source code, to be 146 | distributed under the terms of Sections 1 and 2 above on a medium 147 | customarily used for software interchange; or, 148 | 149 | c) Accompany it with the information you received as to the offer 150 | to distribute corresponding source code. (This alternative is 151 | allowed only for noncommercial distribution and only if you 152 | received the program in object code or executable form with such 153 | an offer, in accord with Subsection b above.) 154 | 155 | The source code for a work means the preferred form of the work for 156 | making modifications to it. For an executable work, complete source 157 | code means all the source code for all modules it contains, plus any 158 | associated interface definition files, plus the scripts used to 159 | control compilation and installation of the executable. However, as a 160 | special exception, the source code distributed need not include 161 | anything that is normally distributed (in either source or binary 162 | form) with the major components (compiler, kernel, and so on) of the 163 | operating system on which the executable runs, unless that component 164 | itself accompanies the executable. 165 | 166 | If distribution of executable or object code is made by offering 167 | access to copy from a designated place, then offering equivalent 168 | access to copy the source code from the same place counts as 169 | distribution of the source code, even though third parties are not 170 | compelled to copy the source along with the object code. 171 | 172 | 4. You may not copy, modify, sublicense, or distribute the Program 173 | except as expressly provided under this License. Any attempt 174 | otherwise to copy, modify, sublicense or distribute the Program is 175 | void, and will automatically terminate your rights under this License. 176 | However, parties who have received copies, or rights, from you under 177 | this License will not have their licenses terminated so long as such 178 | parties remain in full compliance. 179 | 180 | 5. You are not required to accept this License, since you have not 181 | signed it. However, nothing else grants you permission to modify or 182 | distribute the Program or its derivative works. These actions are 183 | prohibited by law if you do not accept this License. Therefore, by 184 | modifying or distributing the Program (or any work based on the 185 | Program), you indicate your acceptance of this License to do so, and 186 | all its terms and conditions for copying, distributing or modifying 187 | the Program or works based on it. 188 | 189 | 6. Each time you redistribute the Program (or any work based on the 190 | Program), the recipient automatically receives a license from the 191 | original licensor to copy, distribute or modify the Program subject to 192 | these terms and conditions. You may not impose any further 193 | restrictions on the recipients' exercise of the rights granted herein. 194 | You are not responsible for enforcing compliance by third parties to 195 | this License. 196 | 197 | 7. If, as a consequence of a court judgment or allegation of patent 198 | infringement or for any other reason (not limited to patent issues), 199 | conditions are imposed on you (whether by court order, agreement or 200 | otherwise) that contradict the conditions of this License, they do not 201 | excuse you from the conditions of this License. If you cannot 202 | distribute so as to satisfy simultaneously your obligations under this 203 | License and any other pertinent obligations, then as a consequence you 204 | may not distribute the Program at all. For example, if a patent 205 | license would not permit royalty-free redistribution of the Program by 206 | all those who receive copies directly or indirectly through you, then 207 | the only way you could satisfy both it and this License would be to 208 | refrain entirely from distribution of the Program. 209 | 210 | If any portion of this section is held invalid or unenforceable under 211 | any particular circumstance, the balance of the section is intended to 212 | apply and the section as a whole is intended to apply in other 213 | circumstances. 214 | 215 | It is not the purpose of this section to induce you to infringe any 216 | patents or other property right claims or to contest validity of any 217 | such claims; this section has the sole purpose of protecting the 218 | integrity of the free software distribution system, which is 219 | implemented by public license practices. Many people have made 220 | generous contributions to the wide range of software distributed 221 | through that system in reliance on consistent application of that 222 | system; it is up to the author/donor to decide if he or she is willing 223 | to distribute software through any other system and a licensee cannot 224 | impose that choice. 225 | 226 | This section is intended to make thoroughly clear what is believed to 227 | be a consequence of the rest of this License. 228 | 229 | 8. If the distribution and/or use of the Program is restricted in 230 | certain countries either by patents or by copyrighted interfaces, the 231 | original copyright holder who places the Program under this License 232 | may add an explicit geographical distribution limitation excluding 233 | those countries, so that distribution is permitted only in or among 234 | countries not thus excluded. In such case, this License incorporates 235 | the limitation as if written in the body of this License. 236 | 237 | 9. The Free Software Foundation may publish revised and/or new versions 238 | of the General Public License from time to time. Such new versions will 239 | be similar in spirit to the present version, but may differ in detail to 240 | address new problems or concerns. 241 | 242 | Each version is given a distinguishing version number. If the Program 243 | specifies a version number of this License which applies to it and "any 244 | later version", you have the option of following the terms and conditions 245 | either of that version or of any later version published by the Free 246 | Software Foundation. If the Program does not specify a version number of 247 | this License, you may choose any version ever published by the Free Software 248 | Foundation. 249 | 250 | 10. If you wish to incorporate parts of the Program into other free 251 | programs whose distribution conditions are different, write to the author 252 | to ask for permission. For software which is copyrighted by the Free 253 | Software Foundation, write to the Free Software Foundation; we sometimes 254 | make exceptions for this. Our decision will be guided by the two goals 255 | of preserving the free status of all derivatives of our free software and 256 | of promoting the sharing and reuse of software generally. 257 | 258 | NO WARRANTY 259 | 260 | 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY 261 | FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN 262 | OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES 263 | PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED 264 | OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 265 | MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS 266 | TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE 267 | PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, 268 | REPAIR OR CORRECTION. 269 | 270 | 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 271 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR 272 | REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, 273 | INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING 274 | OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED 275 | TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY 276 | YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER 277 | PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE 278 | POSSIBILITY OF SUCH DAMAGES. 279 | 280 | END OF TERMS AND CONDITIONS 281 | 282 | How to Apply These Terms to Your New Programs 283 | 284 | If you develop a new program, and you want it to be of the greatest 285 | possible use to the public, the best way to achieve this is to make it 286 | free software which everyone can redistribute and change under these terms. 287 | 288 | To do so, attach the following notices to the program. It is safest 289 | to attach them to the start of each source file to most effectively 290 | convey the exclusion of warranty; and each file should have at least 291 | the "copyright" line and a pointer to where the full notice is found. 292 | 293 | 294 | Copyright (C) 295 | 296 | This program is free software; you can redistribute it and/or modify 297 | it under the terms of the GNU General Public License as published by 298 | the Free Software Foundation; either version 2 of the License, or 299 | (at your option) any later version. 300 | 301 | This program is distributed in the hope that it will be useful, 302 | but WITHOUT ANY WARRANTY; without even the implied warranty of 303 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 304 | GNU General Public License for more details. 305 | 306 | You should have received a copy of the GNU General Public License along 307 | with this program; if not, write to the Free Software Foundation, Inc., 308 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 309 | 310 | Also add information on how to contact you by electronic and paper mail. 311 | 312 | If the program is interactive, make it output a short notice like this 313 | when it starts in an interactive mode: 314 | 315 | Gnomovision version 69, Copyright (C) year name of author 316 | Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 317 | This is free software, and you are welcome to redistribute it 318 | under certain conditions; type `show c' for details. 319 | 320 | The hypothetical commands `show w' and `show c' should show the appropriate 321 | parts of the General Public License. Of course, the commands you use may 322 | be called something other than `show w' and `show c'; they could even be 323 | mouse-clicks or menu items--whatever suits your program. 324 | 325 | You should also get your employer (if you work as a programmer) or your 326 | school, if any, to sign a "copyright disclaimer" for the program, if 327 | necessary. Here is a sample; alter the names: 328 | 329 | Yoyodyne, Inc., hereby disclaims all copyright interest in the program 330 | `Gnomovision' (which makes passes at compilers) written by James Hacker. 331 | 332 | , 1 April 1989 333 | Ty Coon, President of Vice 334 | 335 | This General Public License does not permit incorporating your program into 336 | proprietary programs. If your program is a subroutine library, you may 337 | consider it more useful to permit linking proprietary applications with the 338 | library. If this is what you want to do, use the GNU Lesser General 339 | Public License instead of this License. 340 | -------------------------------------------------------------------------------- /esphome-bathroom.yaml: -------------------------------------------------------------------------------- 1 | substitutions: 2 | device_name: esphome-bathroom 3 | friendly_name: esphome-bathroom 4 | 5 | esphome: 6 | name: esphome-bathroom 7 | platform: ESP32 8 | board: nodemcu-32s 9 | includes: 10 | - oras_dsh.h # File is included in order to manage "global" data between the different sections of lambda code 11 | 12 | # Enable logging 13 | # If using DEBUG level, the BLE tracker will find MAC addresses and service uuid's of any digital shower heads, it can find 14 | # INFO will include information on when shower head is connect/disconnected, BLE datablock changes and the update timestamp for the last datablock change 15 | # WARN will just log information about start time and end time (and relevant info for time calculation) 16 | logger: 17 | level: INFO 18 | 19 | # Enable Home Assistant API 20 | api: 21 | password: !secret esphome_api_password 22 | 23 | ota: 24 | password: !secret esphome_ota_password 25 | 26 | wifi: 27 | ssid: !secret wifi_ssid 28 | password: !secret wifi_password 29 | domain: '.rg47c.lan' 30 | 31 | # Enable fallback hotspot (captive portal) in case wifi connection fails 32 | ap: 33 | ssid: "DSH Fallback Hotspot" 34 | password: "ecEm5NbuUFfg" 35 | 36 | captive_portal: 37 | 38 | web_server: 39 | port: 80 40 | ota: false 41 | include_internal: true 42 | 43 | # Time component is needed for time calculations 44 | time: 45 | - platform: homeassistant 46 | id: homeassistant_time 47 | 48 | # Uncomment if syslogging is used 49 | #syslog: 50 | # ip_address: "192.168.1.25" 51 | # port: 514 52 | 53 | 54 | # Sensors for ESP version and WIFI information 55 | text_sensor: 56 | - platform: version 57 | hide_timestamp: true 58 | name: '${friendly_name} - ESPHome Version' 59 | - platform: wifi_info 60 | ip_address: 61 | name: '${friendly_name} - IP Address' 62 | icon: mdi:wifi 63 | ssid: 64 | name: '${friendly_name} - Connected SSID' 65 | icon: mdi:wifi-strength-2 66 | - platform: template 67 | name: "dsh_lastShowerFinished" 68 | id: dsh_lastShowerFinished 69 | icon: mdi:calendar-clock 70 | update_interval: never 71 | 72 | 73 | esp32_ble_tracker: 74 | scan_parameters: 75 | interval: 1100ms 76 | window: 1100ms 77 | active: true 78 | 79 | 80 | on_ble_advertise: 81 | - then: 82 | - lambda: |- 83 | char stringbuf[256]; // Buffer for outputting raw data in a readable format 84 | char* buf2 = stringbuf; // Pointer for buffer 85 | char* endofbuf = stringbuf + sizeof(stringbuf); // Pointer to end of buffer 86 | int i; // integer to be sued for counter 87 | 88 | if(strcmp(x.get_name().c_str(),"DHS") == 0) { // Check manufacturer name 89 | ESP_LOGI("DSH_tracker", "New BLE device"); 90 | ESP_LOGI("DSH_tracker", " address: %s", x.address_str().c_str()); 91 | ESP_LOGI("DSH_tracker", "(%s) name: %s", x.address_str().c_str(), x.get_name().c_str()); 92 | ESP_LOGI("DSH_tracker", "(%s) Advertised service UUIDs:",x.address_str().c_str()); 93 | for (auto uuid : x.get_service_uuids()) { 94 | ESP_LOGI("DSH_tracker", "(%s) - %s", x.address_str().c_str(), uuid.to_string().c_str()); 95 | } 96 | ESP_LOGI("DSH", "(%s) Advertised service data:",x.address_str().c_str()); 97 | for (auto data : x.get_service_datas()) { 98 | ESP_LOGI("DSH_tracker", "(%s) - %s: (length %i)", x.address_str().c_str(), data.uuid.to_string().c_str(), data.data.size()); 99 | } 100 | ESP_LOGI("DSH_tracker", "(%s) Advertised manufacturer data:",x.address_str().c_str()); 101 | for (auto data : x.get_manufacturer_datas()) { 102 | ESP_LOGI("DSH_tracker", "(%s) - %s: (length %i)", x.address_str().c_str(), data.uuid.to_string().c_str(), data.data.size()); 103 | for(i=0;i<18;i++) { 104 | if (buf2 + 5 < endofbuf) { 105 | if (i > 0) { 106 | buf2 += sprintf(buf2, ":"); 107 | } 108 | buf2 += sprintf(buf2, "%02X", data.data[i]); 109 | } 110 | } 111 | ESP_LOGI("DSH_tracker", "(%s) Data block: %s", x.address_str().c_str(), (char*)stringbuf); 112 | 113 | // Detailed analysis of data - check if shower head is active (only works before connection is established with ble_client) 114 | if ( dsh.occupancy == 0 && data.data[14]==0x32 && data.data[15]==0x4F) { // Enhance filtering on data - to ensure correct match 115 | auto time = id(homeassistant_time).now(); // Get current time 116 | time_t currTime = time.timestamp; 117 | 118 | unsigned long int totShowers = data.data[2]; // Total Showers consist of index 1 and 2 in the array 119 | unsigned long int bathTemp = data.data[11]; // Temperature consist of index 11 in the array 120 | unsigned long int bathKwhDec= data.data[13]; // kWh consumptionm consist of index 12 and 13 in the array (multiplied by 100) 121 | unsigned long int bathLiter = data.data[9]; // L consumptionm consist of index 8 and 9 in the array (multiplied by 100) 122 | unsigned int iShowerDuration = data.data[7]; // idx 6+7 = shower time 123 | 124 | dsh.tStartTime = time.timestamp; // Set start time of shower 125 | ESP_LOGW("DSH_tracker", "Initializing start time to: %ld and setting occupancy on",time.timestamp); 126 | dsh.occupancy =1 ; 127 | 128 | totShowers += ( data.data[1]<<8); // Calculate shower number 129 | dsh.lCurrentShowerNo = totShowers; 130 | dsh.curBathTemp = bathTemp; 131 | bathKwhDec += ( data.data[12]<<8); // Get data for energy (16 bit number) - number must be divided by 100 132 | dsh.curEnergy = (float)bathKwhDec/100; 133 | bathLiter += ( data.data[8]<<8); // Get amount of water (16 bit number) - number must be divided by 10 134 | dsh.curWaterLiters = float(bathLiter)/10; 135 | iShowerDuration += ( data.data[6]<<8); // Get data for shower time (16 bit number) 136 | dsh.curShowerFlowDuration = iShowerDuration; 137 | 138 | if(memcmp(&dsh.bleData[0],&data.data[0],18)!=0) { // If BLE data is different than what we have in the "cache", copy the new data 139 | memcpy(&dsh.bleData[0],&data.data[0],18); 140 | } 141 | ESP_LOGI("DSH_tracker", "Data block changes since last: %s", (char*)stringbuf); 142 | dsh.tLastUpdate = time.timestamp; // Set information about when data was last updated 143 | ESP_LOGI("DSH_tracker", "Timestamp for last update set to: %ld",time.timestamp); 144 | strftime(dsh.szLastShowerEnded, sizeof(dsh.szLastShowerEnded), "%Y-%m-%d %H:%M:%S", localtime(&currTime)); 145 | } 146 | } 147 | } 148 | 149 | # Timer running on 5 sec interval - to ensure fairly quickly updates once the shower is active 150 | interval: 151 | - interval: 5sec 152 | then: 153 | - lambda: |- 154 | // Get current time 155 | auto time = id(homeassistant_time).now(); 156 | // ESP_LOGW("DSH", "Interval timer spawned"); 157 | if ( (time.timestamp - dsh.tLastUpdate) > 180 && dsh.tLastUpdate != 0 ) { // More than 180 seconds has passed since last update, assume finished 158 | unsigned long int showerDurationSecs = dsh.tLastUpdate - dsh.tStartTime; // Calculate shower duration 159 | dsh.occupancy = 0; // Set variable for shower as inactive 160 | ESP_LOGI("DSH", "3 minutes has passed since last updated - shower duration in seconds has been calculated to: %ld seconds",showerDurationSecs); 161 | // Publish LastShower sensors to HA 162 | id(dsh_lastShowerkWh).publish_state(dsh.curEnergy); 163 | id(dsh_lastShowerTemp).publish_state(dsh.curBathTemp); 164 | id(dsh_lastShowerLiter).publish_state(dsh.curWaterLiters); 165 | id(dsh_lastShowerM3).publish_state((float)dsh.curWaterLiters*0.001); 166 | id(dsh_lastDurationSeconds).publish_state(showerDurationSecs); 167 | id(dsh_showerOccupied).publish_state(dsh.occupancy); 168 | id(dsh_lastShowerFinished).publish_state(dsh.szLastShowerEnded); 169 | id(dsh_lastShowerWaterFlowTime).publish_state(dsh.curShowerFlowDuration); 170 | 171 | // Update internal variables for historical lookup 172 | dsh.lastWaterLiters=dsh.curWaterLiters; 173 | dsh.lastEnergy=dsh.curEnergy; 174 | dsh.lastBathTemp=dsh.curBathTemp; 175 | dsh.lastShowerDuration=showerDurationSecs; 176 | dsh.lastShowerFlowDuration = dsh.curShowerFlowDuration; 177 | // Set CurrentShower to NaN - as shower is inactive 178 | id(dsh_curShowerkWh).publish_state(NAN); 179 | id(dsh_curShowerTemp).publish_state(NAN); 180 | id(dsh_curShowerLiter).publish_state(NAN); 181 | id(dsh_curShowerM3).publish_state(NAN); 182 | id(dsh_curShowerTimeSeconds).publish_state(NAN); 183 | id(dsh_curShowerWaterFlowTime).publish_state(NAN); 184 | 185 | // Reset internal counters and data 186 | ESP_LOGI("DSH", "Consider shower to be finished and reset Occupancy"); 187 | dsh.tLastUpdate = 0; 188 | dsh.lLastShowerNo = dsh.lCurrentShowerNo; // Set counter shower number - to be able to identify if current shower continues 189 | } else if ( dsh.tStartTime != 0 && dsh.occupancy==1 && dsh.tLastUpdate != 0) { 190 | // Regular updates every 5 seconds when shower is on 191 | // Only send if more than 10 seconds since last update from BLE device 192 | unsigned long int showerDurationSecs = dsh.tLastUpdate - dsh.tStartTime; // Calculate shower duration 193 | ESP_LOGW("DSH", "Updating HA sensors ... "); 194 | id(dsh_curShowerkWh).publish_state(dsh.curEnergy); 195 | id(dsh_curShowerTemp).publish_state(dsh.curBathTemp); 196 | id(dsh_curShowerLiter).publish_state(dsh.curWaterLiters); 197 | id(dsh_curShowerM3).publish_state((float)dsh.curWaterLiters*0.001); 198 | id(dsh_curShowerTimeSeconds).publish_state(showerDurationSecs); 199 | id(dsh_showerOccupied).publish_state(dsh.occupancy); 200 | id(dsh_totShowers).publish_state(dsh.lCurrentShowerNo); 201 | id(dsh_lastShowerWaterFlowTime).publish_state(dsh.curShowerFlowDuration); 202 | } 203 | 204 | 205 | ble_client: 206 | - mac_address: 60:77:71:3A:D6:BB # Address needs to match shower head - 60:77:71:3A:D6:BB 207 | id: DSH 208 | on_connect: 209 | then: 210 | lambda: |- 211 | auto time = id(homeassistant_time).now(); 212 | ESP_LOGI("DSH", "Shower head connected ..."); 213 | 214 | on_disconnect: 215 | then: 216 | lambda: |- 217 | // In principle a disconnect only means that the shower head disabled BLE - it does not mean, that the shower is finished, 218 | // as there is a 2 minute timeout in the shower head 219 | auto time = id(homeassistant_time).now(); 220 | ESP_LOGI("DSH", "Shower head disconnected - if no new data has been received after approx 3 minutes, the shower is considered finished"); 221 | 222 | # Sensor to indicate whether the shower is busy/occupied or not. 223 | binary_sensor: 224 | - platform: template 225 | name: "dsh_showerOccupied" 226 | id: dsh_showerOccupied 227 | icon: 'mdi:shower-head' 228 | device_class: occupancy 229 | 230 | sensor: 231 | - platform: uptime 232 | name: Uptime Sensor 233 | id: dsh_uptime 234 | internal: true 235 | 236 | # Total number of showers registered by the shower-head 237 | - platform: template 238 | name: "dsh_totShowers" 239 | id: dsh_totShowers 240 | icon: 'mdi:speedometer-medium' 241 | unit_of_measurement: "#" 242 | update_interval: never 243 | 244 | # Current temperature 245 | - platform: template 246 | name: "dsh_curShowerTemp" 247 | id: dsh_curShowerTemp 248 | icon: 'mdi:thermometer' 249 | device_class: temperature 250 | update_interval: never 251 | unit_of_measurement: "°C" 252 | 253 | # Previous temperature 254 | - platform: template 255 | name: "dsh_lastShowerTemp" 256 | id: dsh_lastShowerTemp 257 | icon: 'mdi:thermometer' 258 | device_class: temperature 259 | update_interval: never 260 | unit_of_measurement: "°C" 261 | 262 | # Current energy usage in kwH 263 | - platform: template 264 | name: "dsh_curShowerkWh" 265 | id: dsh_curShowerkWh 266 | device_class: energy 267 | icon: 'mdi:water-thermometer' 268 | accuracy_decimals: 2 269 | unit_of_measurement: "kWh" 270 | update_interval: never 271 | state_class: total_increasing 272 | 273 | # Previous energy usage in kwH 274 | - platform: template 275 | name: "dsh_lastShowerkWh" 276 | id: dsh_lastShowerkWh 277 | device_class: energy 278 | icon: 'mdi:water-thermometer' 279 | accuracy_decimals: 2 280 | unit_of_measurement: "kWh" 281 | update_interval: never 282 | 283 | # Current duration 284 | - platform: template 285 | name: "dsh_curShowerTimeSeconds" 286 | id: dsh_curShowerTimeSeconds 287 | icon: 'mdi:timer' 288 | unit_of_measurement: "s" 289 | update_interval: never 290 | 291 | # Last duration 292 | - platform: template 293 | name: "dsh_lastDurationSeconds" 294 | id: dsh_lastDurationSeconds 295 | icon: 'mdi:timer' 296 | unit_of_measurement: "s" 297 | update_interval: never 298 | 299 | # Duration timer from shower head 300 | - platform: template 301 | name: "dsh_curShowerWaterFlowTime" 302 | id: dsh_curShowerWaterFlowTime 303 | icon: 'mdi:timer' 304 | unit_of_measurement: "s" 305 | update_interval: never 306 | 307 | # Last duration timer from shower head 308 | - platform: template 309 | name: "dsh_lastShowerWaterFlowTime" 310 | id: dsh_lastShowerWaterFlowTime 311 | icon: 'mdi:timer' 312 | unit_of_measurement: "s" 313 | update_interval: never 314 | 315 | # Current water consumption in Liter 316 | - platform: template 317 | name: "dsh_curShowerLiter" 318 | id: dsh_curShowerLiter 319 | device_class: water 320 | icon: 'mdi:water' 321 | unit_of_measurement: "L" 322 | accuracy_decimals: 1 323 | update_interval: never 324 | state_class: total_increasing 325 | 326 | # Last water consumption in Liter 327 | - platform: template 328 | name: "dsh_lastShowerLiter" 329 | id: dsh_lastShowerLiter 330 | device_class: water 331 | icon: 'mdi:water' 332 | unit_of_measurement: "L" 333 | accuracy_decimals: 1 334 | update_interval: never 335 | 336 | # Current water consumption in m³ 337 | - platform: template 338 | name: "dsh_curShowerM3" 339 | id: dsh_curShowerM3 340 | device_class: water 341 | icon: 'mdi:cup-water' 342 | unit_of_measurement: "m³" 343 | accuracy_decimals: 5 344 | update_interval: never 345 | state_class: total_increasing 346 | 347 | # Previous water consumption in m³ 348 | - platform: template 349 | name: "dsh_lastShowerM3" 350 | id: dsh_lastShowerM3 351 | device_class: water 352 | icon: 'mdi:cup-water' 353 | unit_of_measurement: "m³" 354 | accuracy_decimals: 5 355 | update_interval: never 356 | 357 | # Total number of showers - this is where the magic happens 358 | - platform: ble_client 359 | name: "DSH Total Showers" 360 | ble_client_id: DSH 361 | id: dsh_totalShowers 362 | update_interval: never 363 | internal: true 364 | type: characteristic 365 | service_uuid: '7f402200-504f-4c41-5261-6d706869726f' # Not sure if these are the same on all shower heads - as I only have a single showerhead 366 | characteristic_uuid: '7f402203-504f-4c41-5261-6d706869726f' # 367 | notify: true # Enable notifications on the service/charateristic 368 | lambda: |- 369 | auto time = id(homeassistant_time).now(); // Get current time 370 | time_t currTime = time.timestamp; // Struct to generate human readable date/timestamp 371 | char stringbuf[256]; // Buffer for outputting raw data in a readable format 372 | char* buf2 = stringbuf; // Pointer for buffer 373 | char* endofbuf = stringbuf + sizeof(stringbuf); // Pointer to end of buffer 374 | int i; // integer to be sued for counter 375 | uint8_t* pdata = (uint8_t*) x.data(); // The BLE data array 376 | unsigned long int totShowers = pdata[2]; // Total Showers consist of index 1 and 2 in the array 377 | unsigned long int bathTemp = pdata[11]; // Temperature consist of index 11 in the array 378 | unsigned long int bathKwhDec= pdata[13]; // kWh consumptionm consist of index 12 and 13 in the array (multiplied by 100) 379 | unsigned long int bathLiter = pdata[9]; // L consumptionm consist of index 8 and 9 in the array (multiplied by 10) 380 | unsigned int iShowerFlowDuration = pdata[7]; // idx 6+7 = shower time 381 | 382 | totShowers += ( pdata[1]<<8); 383 | // ESP_LOGD("ble_adv", "Total showers %ld", totShowers); 384 | dsh.lCurrentShowerNo = totShowers; 385 | 386 | // Only reset counters when a new shower being started - as it can have paused. This can be identified by the shower number 387 | // retrieved from the BLE data 388 | if(dsh.occupancy == 0 && dsh.lLastShowerNo != dsh.lCurrentShowerNo) { 389 | dsh.tStartTime = time.timestamp; // Set start time of shower 390 | ESP_LOGW("DSH", "Initializing start time to: %ld and setting occupancy on",time.timestamp); 391 | id(dsh_curShowerkWh).publish_state(0); 392 | id(dsh_curShowerTemp).publish_state(0); 393 | id(dsh_curShowerLiter).publish_state(0); 394 | id(dsh_curShowerM3).publish_state(0); 395 | id(dsh_curShowerTimeSeconds).publish_state(0); 396 | id(dsh_curShowerWaterFlowTime).publish_state(0); 397 | memset(&dsh.bleData[0],0,sizeof(dsh.bleData)); // Zeroize data block buffer 398 | dsh.occupancy = 1; // Set shower as active/occupied 399 | id(dsh_showerOccupied).publish_state(dsh.occupancy); // Publish sensor to HA 400 | } 401 | 402 | dsh.curBathTemp = bathTemp; 403 | // ESP_LOGD("ble_adv", "Bath temperature %ld", dsh.curBathTemp); 404 | 405 | bathKwhDec += ( pdata[12]<<8); 406 | dsh.curEnergy = (float)bathKwhDec/100; 407 | // ESP_LOGD("ble_adv", "Bath Energy %f kWh", dsh.curEnergy); 408 | 409 | bathLiter += ( pdata[8]<<8); 410 | dsh.curWaterLiters = float(bathLiter)/10; 411 | // ESP_LOGD("ble_adv", "Bath water consumption %f L", dsh.curWaterLiters); 412 | 413 | iShowerFlowDuration += ( pdata[6]<<8); // Get data for shower time (16 bit number) 414 | dsh.curShowerFlowDuration = iShowerFlowDuration; 415 | 416 | // Find out if data has changed compared to previous notification 417 | if(memcmp(&dsh.bleData[0],pdata,18)!=0) { 418 | // Data is different, copy new data 419 | memcpy(&dsh.bleData[0],pdata,18); 420 | // Dump hex data to the log 421 | for(i=0;i<18;i++) { 422 | if (buf2 + 5 < endofbuf) { 423 | if (i > 0) { 424 | buf2 += sprintf(buf2, ":"); 425 | } 426 | buf2 += sprintf(buf2, "%02X", pdata[i]); 427 | } 428 | } 429 | ESP_LOGI("DSH", "Data block changes since last: %s", (char*)stringbuf); 430 | // Set information about when data was last updated 431 | dsh.tLastUpdate = time.timestamp; 432 | ESP_LOGI("DSH", "Timestamp for last update set to: %ld",time.timestamp); 433 | strftime(dsh.szLastShowerEnded, sizeof(dsh.szLastShowerEnded), "%Y-%m-%d %H:%M:%S", localtime(&currTime)); 434 | // sprintf((char *)dsh.szLastShowerEnded, "%04d-%02d-%02d %02d:%02d:%02d", time.year,time.month,time.day_of_month,time.hour,time.minute,time.second); 435 | } 436 | return(totShowers); 437 | 438 | --------------------------------------------------------------------------------