Skip to content

writememe/fritz_isp_toolkit

Repository files navigation

fritz_isp_toolkit Python 3.7 Python 3.8 Python 3.9 Code Style

Fritz ISP Router Toolkit

A repository to interface with Fritz ISP routers and send notifications via Gmail

Introduction

This tool uses the fritzconnection python module to interface with the Fritz Router so that you can process the device logs off the device.

From there, you have to option to send an email via the Gmail API. Realistically, you could swap out the notification to whatever tool you like.

Preparation

ISP Router - Environmental Variables

The tool ingests environmental variables for authentication to the Fritz ISP router. These are:

  • ISP_RTR_UNAME = your_username
  • ISP_RTR_PWORD = your_password
  • ISP_RTR_ADDRESS = your_isp_router_ip

The tool will prefer environmental variables in the following order:

  1. Any environmental variables set .env file, inside the creds/ folder.
  2. Any other method in which you would like to set the environmental variables by.

Gmail API - Optional

You will need to follow the Gmail Python quickstart guide.

Then, copy the contents of the credentials.json file provided and save to a file called credentials_home_automation.json inside the creds/ folder.

Installation

In order to use the application, please follow the installation instructions below:

  1. Create the virtual environment to run the application in:
virtualenv --python=`which python3` venv
source venv/bin/activate
  1. Install the requirements:
pip install -r requirements.txt

Operating Instructions

In order to operate the tool, please perform the following:

python modules/isp_toolkit.py

This will output a timestamped log in the logs folder.

About

A repository to interface with Fritz routers and send notifications via Gmail

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published