teltasync 0.3.0

Async, typed API client for Teltonika routers, built for Home Assistant

teltasync

teltasync is an async python library for interfacing with Teltonika routers via their HTTP API.

[!NOTE] Please report issues and open pull requests only at Codeberg: https://codeberg.org/dmho/teltasync

Installation

You can install the library using pip:

pip install teltasync

Usage

This is a simple example of how to use the library:

import asyncio

from teltasync import Teltasync


async def main():
    # Create client
    client = Teltasync(
        base_url="https://192.168.1.1/api",  # Full API URL
        username="admin",  # Admin username
        password="YOUR_PASSWORD",  # Admin password
        verify_ssl=False  # Most Teltonika devices use self-signed certs
    )

    try:
        # Get basic device info (no authentication required)
        device_info = await client.get_device_info()
        print(f"Device: {device_info.device_name} ({device_info.device_model})")

        # Validate credentials
        if await client.validate_credentials():
            print("Credentials are valid!")

            # Get detailed system information
            system_info = await client.get_system_info()
            print(f"Firmware version: {system_info.static.fw_version}")

            # Get modem status
            modems = await client.get_modem_status()
            for modem in modems:
                print(f"Modem {modem.id}: {modem.operator} ({modem.conntype})")
                print(f"  Signal: {modem.rssi} dBm")

        else:
            print("Invalid credentials!")

    finally:
        # Always close the session
        await client.close()


# Using as async context manager (recommended)
async def context_manager_example():
    async with Teltasync(
            base_url="https://192.168.1.1/api",
            username="admin",
            password="YOUR_PASSWORD",
            verify_ssl=False
    ) as client:
        device_info = await client.get_device_info()
        print(f"Device: {device_info.device_name}")
        # Session automatically closed when exiting context


# Run the example
if __name__ == "__main__":
    asyncio.run(main())

Supported Devices

Although it was currently only tested against a RUTX50, this library should work with most Teltonika routers that support the HTTP API, including:

• RUT series (RUT240, etc.)
• RUTX series (RUTX09, RUTX11, RUTX12, etc.)
• TRB series gateways
• Other Teltonika devices with HTTP API support

There are fixtures for a few other devices (RUT240, RUT241, RUT950, RUTX12, TRB140, TRB500), but no real-world testing against them was done yet.

Compatibility notes

Some Teltonika devices and firmware versions omit fields that are present on others. For example, older unauthenticated status responses may not include device_model or device_identifier, and some system/device/status responses may omit board.modems. These values are parsed as None, so downstream code should handle them as optional.

Requirements

• Python 3.13+
• aiohttp
• pydantic