├── hacs.json ├── apps └── auto_internet_rebooter.py ├── README.md └── LICENSE /hacs.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "Auto 'Crappy Internet' Rebooter :rocket:", 3 | "content_in_root" : "false", 4 | "render_readme": "true", 5 | "domains": ["media_player", "sensor", "switch"] 6 | } 7 | -------------------------------------------------------------------------------- /apps/auto_internet_rebooter.py: -------------------------------------------------------------------------------- 1 | import appdaemon.plugins.hass.hassapi as hass 2 | from datetime import datetime, time 3 | 4 | # 5 | # Auto Crappy Internet Rebooter 6 | # Developed by @UbhiTS on GitHub 7 | # 8 | # Args: 9 | #internet_health_monitor: 10 | # module: auto_internet_rebooter 11 | # class: AutoInternetRebooter 12 | # internet: 13 | # download: sensor.speedtest_download 14 | # upload: sensor.speedtest_upload 15 | # ping: sensor.speedtest_ping 16 | # switch: switch.garage_internet_switch 17 | # thresholds: 18 | # download_mbps: 50.0 19 | # upload_mbps: 3.5 20 | # ping_ms: 75 21 | # schedule: 22 | # - "04:00:00" 23 | # - "16:00:00" 24 | # notify: 25 | # alexa: media_player.upper_big_bedroom_alexa 26 | # start_time: "08:00:00" 27 | # end_time: "21:30:00" 28 | # debug: false 29 | 30 | 31 | class AutoInternetRebooter(hass.Hass): 32 | 33 | def initialize(self): 34 | 35 | self.debug = True; 36 | self.sensor_download = self.args["internet"]["download"] 37 | self.sensor_upload = self.args["internet"]["upload"] 38 | self.sensor_ping = self.args["internet"]["ping"] 39 | self.switch = self.args["internet"]["switch"] 40 | 41 | self.threshold_download = float(self.args["thresholds"]["download_mbps"]) 42 | self.threshold_upload = float(self.args["thresholds"]["upload_mbps"]) 43 | self.threshold_ping = float(self.args["thresholds"]["ping_ms"]) 44 | 45 | self.schedule = self.args["schedule"] 46 | 47 | self.notify = False 48 | 49 | if "notify" in self.args: 50 | self.notify = True 51 | self.alexa = self.args["notify"]["alexa"] 52 | self.notify_start_time = datetime.strptime(self.args["notify"]["start_time"], '%H:%M:%S').time() 53 | self.notify_end_time = datetime.strptime(self.args["notify"]["end_time"], '%H:%M:%S').time() 54 | 55 | for schedule in self.schedule: 56 | time = datetime.strptime(schedule, '%H:%M:%S').time() 57 | self.run_daily(self.run_speedtest, time) 58 | 59 | # we just need to monitor ping as ping has a precision of 3 (20.943 ms) 60 | # highly unlikely that 2 tests will result in same ping speed 61 | self.listen_state(self.evaluate_internet_health, self.sensor_ping, attribute = "state") 62 | 63 | self.debug_log(f"\n**** INIT - AUTO 'CRAPPY INTERNET' REBOOTER ****\n D/L {self.threshold_download}\n U/L {self.threshold_upload}\n PING {self.threshold_ping}") 64 | 65 | self.debug = bool(self.args["debug"]) if "debug" in self.args else self.debug 66 | 67 | 68 | async def run_speedtest(self, kwargs): 69 | self.debug_log("INTERNET SPEED TEST IN PROGRESS") 70 | self.call_service("homeassistant/update_entity", entity_id = "sensor.speedtest_ping") 71 | 72 | 73 | def evaluate_internet_health(self, entity, attribute, old, new, kwargs): 74 | 75 | speed_download = self.threshold_download 76 | speed_upload = self.threshold_upload 77 | speed_ping = self.threshold_ping 78 | 79 | try: 80 | speed_download = float(self.get_state(self.sensor_download)) 81 | speed_upload = float(self.get_state(self.sensor_upload)) 82 | speed_ping = float(self.get_state(self.sensor_ping)) 83 | except: 84 | pass 85 | 86 | d = speed_download < self.threshold_download 87 | u = speed_upload < self.threshold_upload 88 | p = speed_ping > self.threshold_ping 89 | 90 | if d or u or p: 91 | 92 | log = [] 93 | if d: log += [f"D/L {self.threshold_download}|{speed_download}"] 94 | if u: log += [f"U/L {self.threshold_upload}|{speed_upload}"] 95 | if p: log += [f"PING {self.threshold_ping}|{speed_ping}"] 96 | self.debug_log("INTERNET HEALTH ERROR: " + ", ".join(log)) 97 | self.debug_log("INTERNET POWER CYCLE IN 30 SECS") 98 | 99 | if self.notify and self.is_time_okay(self.notify_start_time, self.notify_end_time): 100 | self.call_service("notify/alexa_media", data = {"type":"tts", "method":"all"}, target = self.alexa, message = "Your attention please, internet power cycle in 30 seconds!") 101 | pass 102 | 103 | self.run_in(self.turn_off_switch, 30) 104 | self.run_in(self.turn_on_switch, 45) 105 | else: 106 | self.debug_log("INTERNET SPEED TEST IS OK") 107 | 108 | 109 | def turn_off_switch(self, kwargs): 110 | self.debug_log("INTERNET RESET : TURN OFF") 111 | self.call_service("switch/turn_off", entity_id = self.switch) 112 | 113 | 114 | def turn_on_switch(self, kwargs): 115 | self.debug_log("INTERNET RESET : TURN ON") 116 | self.call_service("switch/turn_on", entity_id = self.switch) 117 | 118 | 119 | def is_time_okay(self, start, end): 120 | current_time = datetime.now().time() 121 | if (start < end): 122 | return start <= current_time and current_time <= end 123 | else: 124 | return start <= current_time or current_time <= end 125 | 126 | 127 | def debug_log(self, message): 128 | if self.debug: 129 | self.log(message) 130 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Auto 'Crappy Internet' Rebooter :rocket: 2 | 3 | [![hacs_badge](https://img.shields.io/badge/HACS-Default-orange.svg)](https://github.com/custom-components/hacs) 4 | 5 | Automatically reboot your internet :globe_with_meridians: if you use a **[ZWave](https://www.amazon.com/Aeotec-Wireless-Control-Security-Automation/dp/B07PJNL5DB/ref=sr_1_7?dchild=1&keywords=zwave+socket&qid=1587936800&sr=8-7), [Zigbee](https://www.amazon.com/Compatible-SmartThings-switches-Appliances-accessories/dp/B07SSWD5MH/ref=sr_1_3?dchild=1&keywords=zigbee+socket&qid=1587936858&sr=8-3), or Bluetooth switch/socket** for your internet modem. 6 | **This app :small_red_triangle:WILL NOT WORK:small_red_triangle: with WiFi switches/sockets** 7 | 8 | Ever since we've set this up in our home, we've never had to worry about the internet. Infact, I've even forgotten where our modem is :wink: ... Awesome! 9 | 10 | Please ⭐ this repo if you like my work and also check out my other repos like 11 | - [Home Assistant 'STEROIDS' Configuration](https://github.com/UbhiTS/ha-config-ataraxis) 12 | - [Alexa (& Sonos) Talking Clock](https://github.com/UbhiTS/ad-alexatalkingclock) 13 | - [Alexa (& Sonos) Doorbell](https://github.com/UbhiTS/ad-alexadoorbell) 14 | - [Alexa (& Sonos) Door/Window Announce](https://github.com/UbhiTS/ad-alexadoorwindowannounce) 15 | - [Alexa (& Sonos) Smart Talking Thermostat](https://github.com/UbhiTS/ad-alexasmarttalkingthermostat) 16 | - [Auto 'Crappy Internet' Rebooter](https://github.com/UbhiTS/ad-autointernetrebooter) 17 | 18 | Also, if you want to see a walkthrough of my Home Assistant configuration, I have my video walkthrough on youtube below 19 | - [Home Automation on 'STEROIDS' : Video Walkthrough](https://youtu.be/qqktLE9_45A) 20 | 21 | ## Prerequisites 22 | You need the :boom:**SpeedTest.net**:boom: component configured in your configuration.yaml and ensure you "disable polling" using "system options" 23 | ![image](https://github.com/UbhiTS/ad-autointernetrebooter/assets/3799525/1d648cde-dc28-45e3-9b26-91fc169c5d1f) 24 | 25 | ### configuration.yaml 26 | ```yaml 27 | speedtestdotnet: 28 | manual: true 29 | monitored_conditions: 30 | - ping 31 | - download 32 | - upload 33 | ``` 34 | 35 | **if you enable speech notifications, you will also need the [Alexa Media Player or Sonos](https://github.com/custom-components/alexa_media_player) integration** 36 | 37 | ## Installation 38 | Use [HACS](https://github.com/custom-components/hacs) or [download](https://github.com/UbhiTS/ad-autointernetrebooter) the `auto_internet_rebooter.py` from inside the `apps` directory to your local `apps` directory, and add the following configuration to enable the app. 39 | 40 | ## Configuration (with Optional Speech Notifications) 41 | ```yaml 42 | internet_health_monitor: 43 | module: auto_internet_rebooter 44 | class: AutoInternetRebooter 45 | internet: 46 | download: sensor.speedtest_download 47 | upload: sensor.speedtest_upload 48 | ping: sensor.speedtest_ping 49 | switch: switch.garage_internet_switch 50 | thresholds: 51 | download_mbps: 50 52 | upload_mbps: 3.5 53 | ping_ms: 75 54 | schedule: 55 | - "04:00:00" 56 | - "16:00:00" 57 | debug: false 58 | # OPTIONAL SPEECH NOTIFICATIONS 59 | notify: 60 | alexa: media_player.upper_big_bedroom_alexa 61 | start_time: "08:00:00" 62 | end_time: "21:30:00" 63 | # OPTIONAL SPEECH NOTIFICATIONS 64 | ``` 65 | 66 | key | optional | type | description 67 | -- | -- | -- | -- 68 | `module` | **False** | string | The module name of the app 69 | `class` | **False** | string | The name of the Class 70 | `internet\|download` | **False** | speedtest.sensor | SpeedTest Download Sensor 71 | `internet\|upload` | **False** | speedtest.sensor | SpeedTest Upload Sensor 72 | `internet\|ping` | **False** | speedtest.sensor | SpeedTest Ping Sensor 73 | `internet\|switch` | **False** | switch | The switch/socket that powers your internet modem 74 | `thresholds\|download_mbps` | **False** | number | Threshold download speed. The internet will reboot if your download speed falls below this number. 75 | `thresholds\|upload_mbps` | **False** | number | Threshold upload speed. The internet will reboot if your upload speed falls below this number. 76 | `thresholds\|ping_ms` | **False** | number | Threshold ping. The internet will reboot if your ping goes **above** this number. 77 | `schedule` | **False** | list | Define daily schedule when the speed test should run. This is in 24h format. 78 | `notify\|alexa` | True | media_player | Speaker for Speech Notifications (Optional) 79 | `notify\|start_time` | True | time | Only speak between start and end time. So that you don't get awoken when the test runs at 4 AM :stuck_out_tongue_winking_eye:. This is in 24h format 80 | `notify\|end_time` | True | time | Every start has an end. This one too :smirk: 81 | `debug` | True | bool | if True, outputs messages to the AppDaemon Log 82 | 83 | 84 | ## Thank you! :raised_hands: 85 | This app wouldn't be possible without the amazing work done by the developers and community at **[Home Assistant](https://www.home-assistant.io/)**. 86 | 87 | If you like my work and feel gracious, you can buy me a beer below ;) 88 | 89 | 90 | Buy Me A Beer 93 | 94 | 95 | # License 96 | [Apache-2.0](LICENSE). By providing a contribution, you agree the contribution is licensed under Apache-2.0. This is required for Home Assistant contributions. 97 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | --------------------------------------------------------------------------------