Skip to content

cstnn/helium_watchdog

Repository files navigation

This is a wrapper around the BOBCAT 300 hotspot and HELIUM APIs in order to monitor the status and performance of the hotspot.

1. Copy the full repository to your device

2. Open a terminal window depending on your operating system and Move to the directory on your device

cd your_path/helium_watchdog

3. Script helium_watchdog.py is checking :

  • OTA version change
  • Blockchain sync status
  • Rewards change

4. Configure your details and preferences in the "secrets.txt" file

  • cache_name= your hotspot animal name like "alert_shadow_iguana"
  • cache_address= your hotspot public blockchain address like "11q2UB9Cy9GsdHkHCn2K1F2LZLxDSfe9Xa4F3ir1NMfTZZ6bs7R"
  • cache_ip= your internal local IP like "192.168.1.4"
  • sleep= the number of seconds between checks like "7200"
  • send_emails= flag it as "True" if you want to get emails when actions are taken / else "False"
  • email_to= add your email address here
  • log= flag it as "True" if you want to write to a logfile when actions are taken / else "False"
  • verbose= flag it as "True" if you want to see command line print outs when actions are taken / else "False"
  • dry_run= use "True" if you want to just test the script by printing out what actions are taken without actually taking them / else "False"

5. Install the needed libraries from the requirements.txt file

pip3 install -r requirements.txt

6. Make a dry run

  • Change the "dry_run" value to "True" in secrets.txt
  • Maybe also change the "sleep" value to "600" so you don't need to wait too much
  • Run the script python3 helium_watchdog.py

7. If all went ok then deploy !

  • Change the "dry_run" value to "False" in secrets.txt
  • Change the "sleep" value to minimum "3600" (1 hour) but suggested is "7200" (2 hours)
  • Run the script python3 helium_watchdog.py

8. (variant) Script helium_watchdog_reboot_schedule.py is :

  • just rebooting at a regular time interval

9. (variant) Configure your details and preferences in the "secrets.txt" file

  • cache_name= your hotspot animal name like "alert_shadow_iguana"
  • cache_address= your hotspot public blockchain address like "11q2UB9Cy9GsdHkHCn2K1F2LZLxDSfe9Xa4F3ir1NMfTZZ6bs7R"
  • cache_ip= your internal local IP like "192.168.1.4"
  • sleep= the number of seconds between checks like "7200"
  • verbose= flag it as "True" if you want to see command line print outs when actions are taken / else "False"
  • dry_run= use "True" if you want to just test the script by printing out what actions are taken without actually taking them / else "False"

10. (variant) Install the needed libraries from the requirements.txt file

pip3 install requirements.txt

11. (variant) Make a dry run

  • Change the dry_run value to "True" in secrets.txt
  • Maybe also change the sleep value to "600" so you don't need to wait too much
  • Run the script python3 helium_watchdog_reboot_schedule.py

12. (variant) If all went ok then deploy !

  • Change the "dry_run" value to "False" in secrets.txt
  • Change the "sleep" value to minimum "3600" (1 hour) but suggested is "7200" (2 hours)
  • Run the script python3 helium_watchdog_reboot_schedule.py

Please Donate if this is helpful

1399umgdrqkxgNjJsXaaW2xqJtHNXPP5dYKqH7miu7ap83JYTmy

Looking for owners of hotspots from other manufacturers to extend the functionalities !!!

About

A wrapper around the BOBCAT 300 hotspot and HELIUM APIs in order to monitor the status and performance of the hotspot.

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages