speedport-api-expanded 0.7.0__tar.gz

speedport_api_expanded-0.7.0/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2022 Andre Basche
+Copyright (c) 2026 Diego Guillen-Rosaperez
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

speedport_api_expanded-0.7.0/PKG-INFO

@@ -0,0 +1,188 @@
+Metadata-Version: 2.4
+Name: speedport-api-expanded
+Version: 0.7.0
+Summary: Control Telekom Speedport routers with Python
+Home-page: https://github.com/kplrm/speedport-api-expanded
+Author: Andre Basche, Diego Guillen-Rosaperez
+Maintainer: Diego Guillen-Rosaperez
+License: MIT
+Project-URL: GitHub, https://github.com/kplrm/speedport-api-expanded
+Project-URL: PyPI, https://pypi.org/project/speedport-api-expanded/
+Project-URL: Upstream, https://github.com/Andre0512/speedport-api
+Platform: any
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: aiohttp>=3.8
+Requires-Dist: pycryptodome>=3.18
+Dynamic: author
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license
+Dynamic: license-file
+Dynamic: maintainer
+Dynamic: platform
+Dynamic: project-url
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+**This python package is unofficial and is not related in any way to Telekom. It was developed by reversed engineered http requests and can stop working at anytime!**
+  
+## Speedport-API
+[![PyPI - Status](https://img.shields.io/pypi/status/speedport-api-expanded)](https://pypi.org/project/speedport-api-expanded/)
+[![PyPI](https://img.shields.io/pypi/v/speedport-api-expanded?color=blue)](https://pypi.org/project/speedport-api-expanded/)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/speedport-api-expanded)](https://www.python.org/)
+[![PyPI - License](https://img.shields.io/pypi/l/speedport-api-expanded)](https://github.com/kplrm/speedport-api-expanded/blob/main/LICENSE)
+[![PyPI - Downloads](https://img.shields.io/pypi/dm/speedport-api-expanded)](https://pypistats.org/packages/speedport-api-expanded)
+
+Control Telekom Speedport routers with Python!
+
+### Installation
+```commandline
+pip install speedport-api-expanded
+```
+
+For this fork's changes, install from a checkout with `python -m pip install -e .`
+or download a wheel from [GitHub releases](https://github.com/kplrm/speedport-api-expanded/releases).
+The Python import remains `from speedport import Speedport`.
+See [local development and adding features](docs/development.md),
+[contribution guidelines](CONTRIBUTING.md), and [contributors](CONTRIBUTORS.md).
+Store local router credentials in an
+ignored `.env` copied from [.env.example](.env.example); see the guide for loading it.
+
+### Supported Devices
+* Speedport Smart 4
+
+### Commandline tool
+With this shipped commandline tool can a speedport in your network be controlled.
+
+#### Turn wifi off
+```commandline
+$ speedport wifi off
+Turn off wifi...
+```
+
+#### Turn guest wifi on
+```commandline
+$ speedport guest-wifi on
+Turn on guest wifi...
+```
+
+#### Reconnect for new ip address
+```commandline
+$ speedport reconnect
+123.45.67.89 / 5403:f3:35aa:12f:7287:41cf:fb1c:3c83
+Reconnect with internet provider...
+123.45.67.12 / 5403:f3:35fe:12f:7287:41cf:fb1c:3c83
+```
+
+#### Query IPv4 and IPv6 information
+```commandline
+speedport --host 192.168.2.1 ip-info
+speedport --host 192.168.2.1 --batch ip-info
+```
+Prints addresses, gateways, primary/secondary DNS servers, and IPv6 prefixes.
+Batch output uses tab-separated field/value pairs. A password is prompted for
+unless `SPEEDPORT_PASSWORD` is set.
+
+To print only the public IPv4 address, without a label or table:
+```commandline
+python -m speedport --host 192.168.2.1 ip-info --ipv4
+93.218.250.118
+```
+If no public IPv4 address is available, the command exits with an error.
+
+#### Enable wps connect
+```commandline
+$ speedport wps
+Enable wps connect...
+wps connect enabled for 113s...
+```
+
+#### Reboot device
+```commandline
+$ speedport reboot
+Reboot speedport...
+```
+
+#### Print devices
+```commandline
+$ speedport devices
++-------------+---------------------+-------+-----------+
+| ipv4        | name                | type  | connected |
++-------------+---------------------+-------+-----------+
+| 10.5.12.32  | Google-Home-Mini-1  | wlan  | 1         |
+| 10.5.12.157 | PC10-5-12-157       | lan   | 0         |
+| 10.5.12.227 | andre-xps           | wlan5 | 1         |
+```
+
+
+#### Print calls
+```commandline
+$ speedport calls
++-------------+--------+----------+---------------------+
+| number      | type   | duration | date                |
++-------------+--------+----------+---------------------+
+| 01578212345 | missed | 0        | 2024-04-04 09:34:35 |
+| 026361245   | taken  | 1337     | 2024-04-06 05:12:53 |
+| 7866        | dialed | 20       | 2024-04-06 18:39:00 |
+```
+
+### Library
+
+#### IP information example
+```python
+import asyncio
+import os
+from speedport import Speedport
+
+async def ip_info():
+    async with Speedport(
+        os.environ.get("SPEEDPORT_HOST", "192.168.2.1"),
+        os.environ["SPEEDPORT_PASSWORD"],
+    ) as router:
+        info = await router.ip_info
+        print(info["public_ip_v4"], info["public_ip_v6"])
+        print(info)  # All fields, including DNS servers and IPv6 prefixes.
+
+asyncio.run(ip_info())
+```
+
+#### Reconnect example
+```python
+import asyncio
+from speedport import Speedport
+
+async def reconnect():
+    speedport =  Speedport("192.168.1.1")
+    await speedport.login("password123")
+    await speedport.reconnect()
+
+asyncio.run(reconnect())
+```
+
+#### Devices example
+```python
+import asyncio
+from speedport import Speedport
+
+devices = asyncio.run(Speedport().devices)
+for device in devices:
+    print(device.ipv4, device.connected)
+```

speedport_api_expanded-0.7.0/README.md

@@ -0,0 +1,144 @@
+**This python package is unofficial and is not related in any way to Telekom. It was developed by reversed engineered http requests and can stop working at anytime!**
+  
+## Speedport-API
+[![PyPI - Status](https://img.shields.io/pypi/status/speedport-api-expanded)](https://pypi.org/project/speedport-api-expanded/)
+[![PyPI](https://img.shields.io/pypi/v/speedport-api-expanded?color=blue)](https://pypi.org/project/speedport-api-expanded/)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/speedport-api-expanded)](https://www.python.org/)
+[![PyPI - License](https://img.shields.io/pypi/l/speedport-api-expanded)](https://github.com/kplrm/speedport-api-expanded/blob/main/LICENSE)
+[![PyPI - Downloads](https://img.shields.io/pypi/dm/speedport-api-expanded)](https://pypistats.org/packages/speedport-api-expanded)
+
+Control Telekom Speedport routers with Python!
+
+### Installation
+```commandline
+pip install speedport-api-expanded
+```
+
+For this fork's changes, install from a checkout with `python -m pip install -e .`
+or download a wheel from [GitHub releases](https://github.com/kplrm/speedport-api-expanded/releases).
+The Python import remains `from speedport import Speedport`.
+See [local development and adding features](docs/development.md),
+[contribution guidelines](CONTRIBUTING.md), and [contributors](CONTRIBUTORS.md).
+Store local router credentials in an
+ignored `.env` copied from [.env.example](.env.example); see the guide for loading it.
+
+### Supported Devices
+* Speedport Smart 4
+
+### Commandline tool
+With this shipped commandline tool can a speedport in your network be controlled.
+
+#### Turn wifi off
+```commandline
+$ speedport wifi off
+Turn off wifi...
+```
+
+#### Turn guest wifi on
+```commandline
+$ speedport guest-wifi on
+Turn on guest wifi...
+```
+
+#### Reconnect for new ip address
+```commandline
+$ speedport reconnect
+123.45.67.89 / 5403:f3:35aa:12f:7287:41cf:fb1c:3c83
+Reconnect with internet provider...
+123.45.67.12 / 5403:f3:35fe:12f:7287:41cf:fb1c:3c83
+```
+
+#### Query IPv4 and IPv6 information
+```commandline
+speedport --host 192.168.2.1 ip-info
+speedport --host 192.168.2.1 --batch ip-info
+```
+Prints addresses, gateways, primary/secondary DNS servers, and IPv6 prefixes.
+Batch output uses tab-separated field/value pairs. A password is prompted for
+unless `SPEEDPORT_PASSWORD` is set.
+
+To print only the public IPv4 address, without a label or table:
+```commandline
+python -m speedport --host 192.168.2.1 ip-info --ipv4
+93.218.250.118
+```
+If no public IPv4 address is available, the command exits with an error.
+
+#### Enable wps connect
+```commandline
+$ speedport wps
+Enable wps connect...
+wps connect enabled for 113s...
+```
+
+#### Reboot device
+```commandline
+$ speedport reboot
+Reboot speedport...
+```
+
+#### Print devices
+```commandline
+$ speedport devices
++-------------+---------------------+-------+-----------+
+| ipv4        | name                | type  | connected |
++-------------+---------------------+-------+-----------+
+| 10.5.12.32  | Google-Home-Mini-1  | wlan  | 1         |
+| 10.5.12.157 | PC10-5-12-157       | lan   | 0         |
+| 10.5.12.227 | andre-xps           | wlan5 | 1         |
+```
+
+
+#### Print calls
+```commandline
+$ speedport calls
++-------------+--------+----------+---------------------+
+| number      | type   | duration | date                |
++-------------+--------+----------+---------------------+
+| 01578212345 | missed | 0        | 2024-04-04 09:34:35 |
+| 026361245   | taken  | 1337     | 2024-04-06 05:12:53 |
+| 7866        | dialed | 20       | 2024-04-06 18:39:00 |
+```
+
+### Library
+
+#### IP information example
+```python
+import asyncio
+import os
+from speedport import Speedport
+
+async def ip_info():
+    async with Speedport(
+        os.environ.get("SPEEDPORT_HOST", "192.168.2.1"),
+        os.environ["SPEEDPORT_PASSWORD"],
+    ) as router:
+        info = await router.ip_info
+        print(info["public_ip_v4"], info["public_ip_v6"])
+        print(info)  # All fields, including DNS servers and IPv6 prefixes.
+
+asyncio.run(ip_info())
+```
+
+#### Reconnect example
+```python
+import asyncio
+from speedport import Speedport
+
+async def reconnect():
+    speedport =  Speedport("192.168.1.1")
+    await speedport.login("password123")
+    await speedport.reconnect()
+
+asyncio.run(reconnect())
+```
+
+#### Devices example
+```python
+import asyncio
+from speedport import Speedport
+
+devices = asyncio.run(Speedport().devices)
+for device in devices:
+    print(device.ipv4, device.connected)
+```

speedport_api_expanded-0.7.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

speedport_api_expanded-0.7.0/setup.py

@@ -0,0 +1,48 @@
+#!/usr/bin/env python3
+
+from setuptools import setup, find_packages
+
+with open("README.md", "r", encoding="utf-8") as f:
+    long_description = f.read()
+
+setup(
+    name="speedport-api-expanded",
+    version="0.7.0",
+    author="Andre Basche, Diego Guillen-Rosaperez",
+    maintainer="Diego Guillen-Rosaperez",
+    description="Control Telekom Speedport routers with Python",
+    long_description=long_description,
+    long_description_content_type="text/markdown",
+    url="https://github.com/kplrm/speedport-api-expanded",
+    project_urls={
+        "GitHub": "https://github.com/kplrm/speedport-api-expanded",
+        "PyPI": "https://pypi.org/project/speedport-api-expanded/",
+        "Upstream": "https://github.com/Andre0512/speedport-api",
+    },
+    license="MIT",
+    platforms="any",
+    packages=find_packages(),
+    include_package_data=True,
+    python_requires=">=3.8",
+    install_requires=["aiohttp>=3.8", "pycryptodome>=3.18"],
+    classifiers=[
+        "Development Status :: 4 - Beta",
+        "Environment :: Console",
+        "License :: OSI Approved :: MIT License",
+        "Natural Language :: English",
+        "Operating System :: OS Independent",
+        "Programming Language :: Python :: 3.8",
+        "Programming Language :: Python :: 3.9",
+        "Programming Language :: Python :: 3.10",
+        "Programming Language :: Python :: 3.11",
+        "Programming Language :: Python :: 3.12",
+        "Programming Language :: Python :: 3.13",
+        "Programming Language :: Python :: 3.14",
+        "Topic :: Software Development :: Libraries :: Python Modules",
+    ],
+    entry_points={
+        "console_scripts": [
+            "speedport = speedport.__main__:start",
+        ]
+    },
+)

speedport_api_expanded-0.7.0/speedport/__init__.py

@@ -0,0 +1,3 @@
+from .speedport import Speedport
+
+__all__ = ["Speedport"]

speedport_api_expanded-0.7.0/speedport/__main__.py

@@ -0,0 +1,239 @@
+#!/usr/bin/env python
+
+import argparse
+import asyncio
+import logging
+import os
+import sys
+import time
+from getpass import getpass
+from pathlib import Path
+
+if __name__ == "__main__":
+    sys.path.insert(0, str(Path(__file__).parent.parent))
+
+from speedport.speedport import Speedport
+
+_LOGGER = logging.getLogger("speedport")
+
+
+def set_logger(args):
+    logging.getLogger("aiohttp").setLevel(logging.WARNING)
+    if args["debug"]:
+        _LOGGER.setLevel(logging.DEBUG)
+        formatter = logging.Formatter("%(levelname)s - %(message)s")
+    elif args["quiet"]:
+        _LOGGER.setLevel(logging.WARNING)
+        formatter = logging.Formatter("%(message)s")
+    else:
+        _LOGGER.setLevel(logging.INFO)
+        formatter = logging.Formatter("%(message)s")
+    console_handler = logging.StreamHandler(sys.stdout)
+    console_handler.setFormatter(formatter)
+    _LOGGER.addHandler(console_handler)
+
+
+def data_table(data, keys):
+    columns = {}
+    for key in keys:
+        columns[key] = max([len(str(d[key])) for d in data] + [len(key)])
+    line = (
+        "+-"
+        + "-+-".join([f"{'-' * length}" for key, length in columns.items()])
+        + "-+\n"
+    )
+    text = (
+        f"{line}| "
+        + " | ".join([f"{key:<{length}}" for key, length in columns.items()])
+        + f" |\n{line}"
+    )
+    for d in data:
+        text += (
+            "| "
+            + " | ".join(
+                [f"{str(d[key]):<{length}}" for key, length in columns.items()]
+            )
+            + " |\n"
+        )
+    return text + line
+
+
+def batch_output(devices):
+    for device in devices.values():
+        print(
+            int(device.connected),
+            device.ipv4,
+            device.type,
+            device.name,
+            sep="\t",
+        )
+
+
+def get_arguments():
+    """Get parsed arguments."""
+    parser = argparse.ArgumentParser(description="Speedport: Command Line Utility")
+    parser.add_argument(
+        "-H",
+        "--host",
+        help="ip address or hostname of Speedport webinterface",
+        default=os.environ.get("SPEEDPORT_HOST", "speedport.ip"),
+    )
+    parser.add_argument(
+        "-s", "--https", help="use https connection", action="store_true"
+    )
+    parser.add_argument(
+        "-p",
+        "--password",
+        help="password of Speedport webinterface (default: SPEEDPORT_PASSWORD)",
+        default=os.environ.get("SPEEDPORT_PASSWORD"),
+    )
+    parser.add_argument(
+        "-d", "--debug", help="enable debug logging", action="store_true"
+    )
+    parser.add_argument("-q", "--quiet", help="output only errors", action="store_true")
+    parser.add_argument(
+        "-b", "--batch", help="print output for batch processing", action="store_true"
+    )
+    parser.add_argument(
+        "-t", "--table", help="print output as table (default)", action="store_true"
+    )
+    subparser = parser.add_subparsers(
+        title="commands", metavar="COMMAND", required=True
+    )
+    for network in ["", "guest-", "office-"]:
+        wifi = subparser.add_parser(f"{network}wifi", help=f"Turn on/off {network}wifi")
+        wifi.add_argument(
+            f"{network}wifi", choices=["on", "off"], help=f"Turn on/off {network}wifi"
+        )
+    reconnect = subparser.add_parser(
+        "reconnect", help="Reconnect internet and receive new ip"
+    )
+    reconnect.set_defaults(reconnect=True)
+    reboot = subparser.add_parser("reboot", help="Reboot device")
+    reboot.set_defaults(reboot=True)
+    wps = subparser.add_parser("wps", help="Turn on wps for 2 minutes")
+    wps.set_defaults(wps=True)
+    devices = subparser.add_parser("devices", help="Output devices")
+    devices.set_defaults(devices=True)
+    calls = subparser.add_parser("calls", help="Output calls")
+    calls.set_defaults(calls=True)
+    ip_info = subparser.add_parser("ip-info", help="Output IPv4 and IPv6 information")
+    ip_info.set_defaults(ip_info=True)
+    ip_info.add_argument(
+        "--ipv4", help="Print only the public IPv4 address", action="store_true"
+    )
+    return vars(parser.parse_args())
+
+
+async def check_args(speedport, args):
+    if args.get("ip_info"):
+        info = await speedport.ip_info
+        if args.get("ipv4"):
+            address = info.get("public_ip_v4")
+            if not address:
+                raise SystemExit("Router did not report a public IPv4 address")
+            print(address)
+        elif args.get("batch"):
+            for key, value in info.items():
+                print(key, value, sep="\t")
+        else:
+            print(
+                data_table(
+                    [{"field": key, "value": value} for key, value in info.items()],
+                    ["field", "value"],
+                )
+            )
+    if args.get("wps"):
+        await wps_enable(args, speedport)
+    if args.get("reconnect"):
+        await reconnect(args, speedport)
+    if args.get("reboot"):
+        await speedport.reboot()
+    if args.get("devices"):
+        if args.get("batch"):
+            batch_output(await speedport.devices)
+        else:
+            print(
+                data_table(
+                    (await speedport.devices).values(),
+                    ["ipv4", "name", "type", "connected"],
+                )
+            )
+    if args.get("calls"):
+        if args.get("batch"):
+            batch_output(await speedport.devices)
+        else:
+            print(
+                data_table(
+                    await speedport.calls,
+                    ["number", "type", "duration", "date"],
+                )
+            )
+
+
+async def check_wifi_args(speedport, args):
+    if args.get("wifi") and args["wifi"] == "on":
+        await speedport.wifi_on()
+    elif args.get("wifi") and args["wifi"] == "off":
+        await speedport.wifi_off()
+    if args.get("guest-wifi") and args["guest-wifi"] == "on":
+        await speedport.wifi_guest_on()
+    elif args.get("guest-wifi") and args["guest-wifi"] == "off":
+        await speedport.wifi_guest_off()
+    if args.get("office-wifi") and args["office-wifi"] == "on":
+        await speedport.wifi_office_on()
+    elif args.get("office-wifi") and args["office-wifi"] == "off":
+        await speedport.wifi_office_off()
+
+
+async def main():
+    args = get_arguments()
+    set_logger(args)
+    password = ""
+    if not args.get("devices"):
+        if not (password := args["password"]):
+            password = getpass("Password of Speedports webinterface: ")
+    async with Speedport(args["host"], password, args.get("https")) as speedport:
+        await check_wifi_args(speedport, args)
+        await check_args(speedport, args)
+
+
+async def reconnect(args, speedport):
+    if not args.get("quiet"):
+        await speedport.update_ip_data()
+        _LOGGER.info(f"{speedport.public_ip_v4} / {speedport.public_ip_v6}")
+    await speedport.reconnect()
+    if not args.get("quiet"):
+        for i in range(240):
+            await speedport.update_ip_data()
+            if await speedport.online_status == "online":
+                _LOGGER.info(f"{speedport.public_ip_v4} / {speedport.public_ip_v6}")
+                break
+            await asyncio.sleep(0.5)
+            print(f"Connecting.{'.' * (i % 3)}  ", end="\r", flush=True)
+
+
+async def wps_enable(args, speedport):
+    await speedport.wps_on()
+    if not args.get("quiet"):
+        event = time.time()
+        next_time = event
+        while await speedport.wps_state == 1:
+            await asyncio.sleep(next_time - time.time())
+            next_time = time.time() + 1
+            print(
+                f"wps connect enabled for {120 - int(time.time() - event)}s...",
+                end="\r",
+                flush=True,
+            )
+
+
+def start():
+    try:
+        asyncio.run(main())
+    except KeyboardInterrupt:
+        print("Aborted.")
+
+
+if __name__ == "__main__":
+    start()