🔧 Teltonika Config Tool

A professional configuration and management tool for Teltonika industrial routers and gateways (TRB140, RUT955, etc.). This tool simplifies device configuration, backup/restore operations, and remote monitoring via SSH connection.

Developed by Gia Huy Engineering - BMS & Automation Solutions

✨ Why this tool?

• 🚀 All-in-one: Backup, restore, configure, and monitor in a single app
• 📊 Excel Export: Pull device configuration to Excel with human-readable values
• 🔄 Batch Config: Push configuration changes from Excel back to device
• 📱 Mobile/SMS Control: Check signal, SIM status, send test SMS
• 💻 SSH Terminal: Execute commands with preset categories

---

🧭 Quick Navigation

👤 For USERS:

I want to...	Go to
Install and run the app	🚀 Installation
See what the app can do	✨ Features
Learn how to use it	📖 Usage Guide
Check logs for debugging	📝 Logging

💻 For DEVELOPERS new to the project:

I want to...	See
Understand project	This README (reading now)
Understand code architecture	docs/ARCHITECTURE.md
Add new features	🔧 Development
Understand Value Mapping	docs/VALUE_MAPPING.md
Understand UCI/Modbus	docs/UCI_MODBUS_CLIENT.md
UI/UX guidelines	docs/UI_DESIGN.md
View changelog	CHANGELOG.md
View roadmap	ROADMAP.md

📚 Recommended reading flow for new developers:

1. README.md             →  Project overview
2. docs/ARCHITECTURE.md  →  Code structure & flow
3. Run: python main.py   →  Experience the app
4. docs/VALUE_MAPPING.md →  Mapping mechanism
5. Read: src/app.py      →  Entry point of logic

---

✨ Features

🔗 Connection

• ✅ SSH connection to device
• ✅ Cancel pending connection
• ✅ Auto-reconnect after reboot
• ✅ Ping Test
• ✅ Open WebUI in browser

💾 Backup & Restore

• ✅ Full configuration backup (tar.gz)
• ✅ Restore from backup file
• ✅ Reboot device
• ✅ Factory Reset

📱 Mobile & SMS

• ✅ Check signal strength (RSRP, RSSI, SINR)
• ✅ Check SIM status (ICCID, IMSI, Operator)
• ✅ Restart modem
• ✅ Toggle mobile connection
• ✅ Send test SMS

📋 Configuration

• ✅ Pull configuration to TXT file
• ✅ Pull configuration to Excel (with Value Mapping)
• ✅ Push configuration from file to device
• ✅ Compare configuration (file vs device)
• ✅ Special handling for Modbus Client

📁 Project Structure

TRB140_Config/
├── main.py                  # Entry point
├── config.json              # Value mappings
├── requirements.txt         # Dependencies
├── Export/                  # Output directory
├── logs/                    # Log files
│   ├── session_activity.log
│   └── debug_errors.log
└── src/                     # Source code
    ├── app.py               # Main Application (GUI)
    ├── utils.py             # Logging utilities
    ├── services/
    │   ├── ssh_manager.py   # SSH connection, AutoReconnect
    │   ├── value_mapper.py  # Display ↔ Raw value conversion
    │   └── config_manager.py # Backup, Restore, Pull, Push, Compare
    ├── parsers/
    │   └── uci_parser.py    # UCI format parser
    └── ui/
        └── theme.py         # Colors, Fonts, Sizes

🚀 Installation

Requirements

• Python 3.10+
• Windows 10/11

Install dependencies

pip install -r requirements.txt

Run the application

python main.py

📖 Usage Guide

1. Connect to device

1. Enter IP Address (default: 192.168.1.205)
2. Enter Username (default: root)
3. Enter Password
4. Click 🔗 Connect

2. Backup configuration

1. Connect to device
2. Click 💾 Backup
3. Backup file will be saved to Export/ directory

3. Pull configuration

• Pull to TXT: Export all config files to a single text file
• Pull to Excel: Export config with table format, includes Value Mapping for Modbus

4. Push configuration

1. Connect to device
2. Select config file (.txt or .xlsx)
3. Click 📤 Push
4. Confirm the operation

5. Compare configuration

1. Connect to device
2. Click 🔍 Compare
3. Select config file to compare
4. View the generated diff report

⚙️ Value Mapping Configuration

The config.json file contains mappings to convert raw values to user-friendly text:

{
    "value_mappings": {
        "modbus_client_alarm_enable": {
            "description": "Alarm On/Off status",
            "mappings": [
                { "raw": "0", "display": "Off" },
                { "raw": "1", "display": "On" }
            ]
        }
    }
}

📝 Logging

• Activity Log: logs/session_activity.log - Records activities
• Error Log: logs/debug_errors.log - Records errors

🔧 Development

Adding new features

1. Create method in src/app.py for UI
2. Add business logic to src/services/
3. Update UI in _create_*_section()

Adding new Value Mapping

1. Open config.json
2. Add mapping following the format above
3. Restart the application

📋 Common UCI Commands

# View configuration
uci show <config>

# Set value
uci set <config>.<section>.<option>=<value>

# Commit changes
uci commit <config>

# View network status
cat /tmp/sysinfo/model
gsmctl -q  # Signal strength
gsmctl -n  # ICCID
gsmctl -x  # IMSI

📚 Documentation

📑 Project Documents

File	Description
CHANGELOG.md	📜 Development history & changes
ROADMAP.md	🗺️ Ideas & feature plans

📖 Technical Documentation (in docs/)

File	Description
docs/ARCHITECTURE.md	🏗️ System architecture & code structure
docs/VALUE_MAPPING.md	📋 Detailed Value Mapping guide
docs/UCI_MODBUS_CLIENT.md	🔧 UCI fields for Modbus Client
docs/UI_DESIGN.md	🎨 UI/UX design guidelines
docs/REFERENCES.md	🔗 Reference links & common commands

🔗 Official Teltonika Documentation

Document	Link
TRB140 Wiki	https://wiki.teltonika-networks.com/view/TRB140
Shell Commands	https://wiki.teltonika-networks.com/view/Shell_Commands
UCI Commands	https://wiki.teltonika-networks.com/view/UCI_command_usage
Gsmctl Commands	https://wiki.teltonika-networks.com/view/Gsmctl_commands
Modbus Client	https://wiki.teltonika-networks.com/view/Modbus_TCP_Client_configuration_example

🤝 Contributing

Contributions are welcome! Please:

1. Fork the repository
2. Create a new branch (git checkout -b feature/AmazingFeature)
3. Commit changes (git commit -m 'Add some AmazingFeature')
4. Push to branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

---

📄 License

This project is distributed under the MIT License.

👥 Author

Mr.ThanhRòm

• Version: 1.0.0-beta
• Last updated: 13/12/2024

---

Made with ❤️ for Teltonika device management