README

MuTerm

MuTerm, Modbus RTU, Modbus ASCII, IEC 62056-21 gibi endüstriyel cihazlarla seri port (RS232 / RS485) veya TCP soket bağlantısı üzerinden haberleşmek için geliştirilmiş, Windows ve Linux üzerinde çalışabilen bir terminal yazılımıdır. Proje, Lazarus / Free Pascal ile geliştirilmiştir ve esnek bir Pascal betik motoru sunar. Gerçek donanım olmadan test için Python tabanlı cihaz simülatörleri de içerir.

⚠️ Lisans Notu: Proje yazarı Mehmet Ulukaya, tüm haklarının saklı olduğunu ve yazılımın ticari ürünlerde kullanılmaması gerektiğini açıkça belirtmiştir. Yazılımı kendi projelerinizde kullanacaksanız kendi çözümünüzü geliştirmeniz önerilir.

İçindekiler

1. Özellikler
2. Çalışma Prensibi
3. Mimari ve Bileşenler
4. Proje Yapısı
5. Veri Akışı
6. Kurulum ve Derleme
7. Kullanım Senaryoları
8. Betik Motoru
9. Simülatörler ve Yardımcı Araçlar
10. Platform Desteği ve Sınırlamalar
11. Katkıda Bulunma
12. Kaynaklar

Özellikler

Bağlantı Katmanı

• Seri Port İletişimi: RS232, RS485 arayüzleri üzerinden Modbus RTU ve ASCII protokolleriyle haberleşme. Baud rate, veri biti, parity ve stop biti gibi parametreler yapılandırılabilir.
• TCP Soket Desteği: Hem TCP istemci hem de TCP sunucu modlarında çalışabilir. Yerel ağ veya internet üzerinden Modbus TCP / HTTP gibi protokollerle haberleşme sağlar.

Betik ve Komut Desteği

• Pascal Betik Motoru: Cihazlarla özel iletişim rutinleri (döngüsel sorgulama, otomatik yanıt, veri dönüştürme vb.) yazmak için Pascal tabanlı betik desteği.
• Send Alanı Komut Dili: :COMM_SETUP, :SEND_TEXT, :COM_RECV_TEXT, :WAIT gibi hazır komutlar; değişkenler ({isim}), etiketler, :GOTO, :IF / :ELSE blokları ve ifade işlevleri (POS, CONTAINS, LEN, TRIM ...). Ayrıntılar: docs/script-commands.md.
• Zaman Aşımı Yönetimi: :COM_RECV_TEXT, :COM_WAIT_FOR_TEXT gibi komutlar TIMEOUT değişkenini günceller; betikler koşullu olarak hata yoluna ayrılabilir.
• Komut Editörü: Betik yazarken CTRL+Space kısayolu ile komut tamamlama / öneri listesi sunar.

Arayüz ve Günlükleme

• Özelleştirilebilir Günlük Ekranı: ASCII günlük ekranı için TrueType yazı tipi değiştirilebilir; okunabilirlik artırılabilir.
• Ayar Yönetimi: Bağlantı parametreleri ve betik ayarları kalıcı olarak saklanır.

Platform Desteği

• Windows ve Linux (Debian tabanlı Mint 32-bit üzerinde test edilmiştir).
• Taşınabilir (portable) kullanım hedeflenmiştir.

Çalışma Prensibi

MuTerm'in temel akışı şu adımlardan oluşur:

1. Kullanıcı bir bağlantı türü seçer: Seri Port veya TCP Soket.
2. Seçilen bağlantı türü için parametreler yapılandırılır (port adı, baud rate, IP, port numarası vb.).
3. Bağlantı kurulur; başarısız olursa hata mesajı gösterilir ve kullanıcı yeniden yapılandırmaya yönlendirilir.
4. Bağlantı kurulduktan sonra kullanıcı iki moddan birini kullanabilir:
   • Manuel Komut Gönderimi: Arayüz üzerinden elle komut yazıp gönderme.
   • Pascal Betiği Çalıştırma: Önceden yazılmış bir betik ile otomatik sorgulama / yanıt döngüsü.
5. Gönderilen veri cihaza iletilir, cihazdan gelen yanıt alınır ve günlük ekranında görüntülenir.
6. Bağlantı devam ettiği sürece bu döngü sürer; kullanıcı bağlantıyı kapattığında oturum sonlanır.

Aşağıdaki Mermaid diyagramı bu akışı özetler:

flowchart TD
    A[Kullanıcı Arayüzü] --> B{Bağlantı Türü Seçimi}
    
    B -->|Seri Port| C[Seri Port Yapılandırması<br>Baud, Veri Bitleri, Parity,<br>Stop Biti, Port Seçimi]
    B -->|TCP| D[TCP Yapılandırması<br>İstemci veya Sunucu,<br>IP Adresi, Port]
    
    C --> E[Bağlantı Kur]
    D --> E
    
    E --> F{Bağlantı Başarılı mı?}
    F -->|Hayır| G[Hata Mesajı Göster]
    G --> B
    
    F -->|Evet| H[Veri Alışverişi Modu]
    
    H --> I[Manuel Komut Gönder]
    H --> J[Pascal Betiği Çalıştır]
    
    I --> K[Veriyi Cihaza Gönder]
    J --> K
    
    K --> L[Cihazdan Yanıt Al]
    L --> M[Yanıtı Günlük Ekranında Göster]
    M --> N{Bağlantı Devam Ediyor mu?}
    N -->|Evet| H
    N -->|Hayır| O[Bağlantıyı Kapat]

Mimari ve Bileşenler

MuTerm, sorumlulukların ayrıştırıldığı modüler bir yapıya sahiptir. Her birim (unit) belirli bir görevi üstlenir:

flowchart LR
    subgraph UI["Kullanıcı Arayüzü Katmanı"]
        MAIN[main.pas / main.lfm<br>Ana Form ve Arayüz Mantığı]
        ICON[MuAppIcon.pas<br>Uygulama Simgesi Yönetimi]
    end
    
    subgraph CORE["Çekirdek Katman"]
        CMD[MuCommands.pas<br>Betik Komut Motoru]
        EXPR[MuExpr.pas<br>İfade Değerlendirici]
        SET[MuSettings.pas<br>Ayar Yönetimi]
        LOG[MuLogging.pas<br>Günlük Kaydı]
    end
    
    subgraph IO["Giriş/Çıkış Katmanı"]
        LIBS[MuLibs.pas<br>Yardımcı Kütüphaneler /<br>Seri Port Katmanı]
        COMP[components/<br>Ek Bileşenler]
    end
    
    subgraph DEVICE["Hedef Cihazlar"]
        SERIAL[Seri Cihaz<br>RS232 / RS485]
        NET[TCP Cihaz<br>Modbus TCP / HTTP]
    end
    
    MAIN --> CMD
    MAIN --> SET
    MAIN --> LOG
    MAIN --> LIBS
    CMD --> EXPR
    CMD --> LIBS
    SET --> LOG
    LIBS --> COMP
    LIBS --> SERIAL
    LIBS --> NET

Proje Yapısı

Depo kök dizininde yer alan dosya ve klasörler:

Veri Akışı

Aşağıdaki diyagram, bir komutun kullanıcıdan cihaza ve geri dönüş yolculuğunu gösterir:

sequenceDiagram
    participant U as Kullanıcı
    participant UI as Ana Arayüz<br>(main.pas)
    participant CMD as Betik Motoru<br>(MuCommands.pas)
    participant IO as IO Katmanı<br>(MuLibs.pas)
    participant D as Hedef Cihaz<br>(Seri / TCP)
    participant LOG as Günlük<br>(MuLogging.pas)
    
    U->>UI: Komut gir / Betik çalıştır
    UI->>CMD: Betik varsa yorumla
    CMD-->>UI: Yürütülecek komut(lar)
    UI->>IO: Veriyi gönder
    IO->>D: Protokol paketi (Modbus RTU/ASCII/TCP)
    D-->>IO: Yanıt paketi
    IO-->>UI: Ham yanıt verisi
    UI->>LOG: Yanıtı kaydet
    LOG-->>U: Günlük ekranında göster

Kurulum ve Derleme

Gereksinimler

• Lazarus IDE (proje tarihsel olarak Lazarus 1.0 – 1.6 aralığında geliştirilmiştir)
• Free Pascal Compiler (FPC)
• İşletim sistemi: Windows veya Linux (Debian tabanlı dağıtımlar test edilmiştir)

Derleme Adımları

1. Lazarus IDE'yi sisteminize kurun.
2. Depoyu klonlayın:
   bashCopy

   git clone https://github.com/mehmetulukaya/muterm.git
   cd muterm

3. MUTerm.lpi proje dosyasını Lazarus IDE ile açın.
4. Hedef platformu seçin:
   • Windows: Varsayılan hedef.
   • Linux: Proje ayarlarından hedef işletim sistemini Linux olarak değiştirin.
5. Build veya Run komutunu çalıştırın.
6. Derleme çıktısı binaryfiles/ klasöründe veya proje kökünde oluşacaktır.

CI / Otomatik Derleme

Projede GitHub Actions iş akışları bulunmaktadır (.github/workflows/). Bu iş akışları, Lazarus derleme günlüğünü yakalayıp hataları raporlar. Önceden AppVeyor ve Travis CI kullanılıyordu; şu anda GitHub Actions'a geçiş yapılmıştır.

Kullanım Senaryoları

Senaryo 1: Seri Port ile Modbus RTU Cihazına Bağlanma

1. Uygulamayı başlatın.
2. Bağlantı türü olarak Seri Port seçin.
3. Port adını (ör. COM3 veya /dev/ttyUSB0), baud rate'i (ör. 9600), veri bitini, parity'yi ve stop bitini ayarlayın.
4. Bağlan düğmesine tıklayın.
5. Manuel komut alanına Modbus sorgu çerçevesini girin veya hazır bir betik yükleyin.
6. Yanıtları günlük ekranında izleyin.

Senaryo 2: TCP Soket ile Modbus TCP Cihazına Bağlanma

1. Bağlantı türü olarak TCP seçin.
2. İstemci modunu seçin; hedef IP adresini ve portu (varsayılan Modbus TCP portu 502) girin.
3. Bağlan düğmesine tıklayın.
4. Manuel komut veya betik ile sorgulama yapın.
5. Gelen yanıtları günlük ekranında görüntüleyin.

Senaryo 3: Otomatik Sorgulama Betiği

1. Komut editörünü açın.
2. CTRL+Space ile komut önerilerinden yararlanarak bir Pascal betiği yazın (ör. belirli aralıklarla register okuma).
3. Betiği çalıştırın; MuTerm sorguları otomatik olarak gönderir ve yanıtları günlüğe kaydeder.

Senaryo 4: Donanım Olmadan Simülatörle Test

1. Bir terminalde Modbus veya IEC 62056-21 simülatörünü başlatın:
   bashCopy

   ./tools/mu_sim.py --pty --pty-link /tmp/muterm-pty
   # veya
   ./tools/mu_counter.py --pty --pty-link /tmp/muterm-counter

2. Çıktıda bildirilen /tmp/... yolunu MuTerm'de port olarak seçin.
3. Hazır betiği (tools/modbus_demo.scp) veya docs/script-commands.md içindeki el sıkışma betiğini çalıştırın.
4. Yanıtları günlük ekranında izleyin; --hex ve --debug ile ham çerçeveleri inceleyin.

Betik Motoru

MuCommands.pas içinde yer alan betik motoru, cihazlarla özel iletişim rutinleri yazmayı sağlar. Send alanındaki :KOMUT(...) satır dili; değişkenleri, etiketleri, :GOTO atlamalarını, tek satırlık ve blok :IF / :ELSE yapılarını destekler. Koşullar MuExpr.pas tarafından değerlendirilir; POS, POSP, CONTAINS, LEN, TRIM, UPPER, LOWER gibi işlevler ve TIMEOUT değişkeni kullanılabilir.

:SET(isim,Ahmet)
:SET(mesaj,MERHABA {isim}!#013#010)
:SEND_TEXT({mesaj})

:LABEL BASLA
:COM_RECV_TEXT(cevap,1.0)
:IF(TIMEOUT = 1) GOTO HATA
:WAIT 1.0
:GOTO BASLA

:LABEL HATA
:SEND_TEXT(Zaman asimi#013#010)
:END

Tipik kullanım alanları:

• Belirli aralıklarla otomatik sorgulama (polling)
• Gelen verilere göre koşullu yanıt üretme
• Veri dönüştürme ve biçimlendirme
• Çok adımlı protokol sekansları (el sıkışma, kimlik doğrulama vb.)

Komutların tam listesi ve ifade dili için docs/script-commands.md dosyasına bakın. Komut editörü ayrıca yazım sırasında CTRL+Space ile otomatik tamamlama sunar.

Simülatörler ve Yardımcı Araçlar

tools/ dizini, MuTerm'i gerçek donanım olmadan denemek için Python tabanlı simülatörler ve kurulum betikleri içerir. Ayrıntılı kullanım ve tüm seçenekler: tools/README.md.

Her iki simülatör de root gerektirmeyen bir PTY ile başlatılabilir:

./tools/mu_sim.py --pty --pty-link /tmp/muterm-pty
./tools/mu_counter.py --pty --pty-link /tmp/muterm-counter

Çıktıda bildirilen yolu MuTerm'de port olarak açın. mu_counter.py, seri port yardımcılarını mu_sim.py'den aldığı için iki dosya aynı dizinde kalmalıdır. RTS/DTR/CTS/DSR gibi modem hatlarını denemek için PTY yerine tty0tty veya gerçek bir UART kullanın.

Platform Desteği ve Sınırlamalar

Katkıda Bulunma

Proje kişisel bir proje olup yazarın tüm hakları saklıdır. Ticari kullanım için lütfen yazarla iletişime geçin. Katkı sağlamak isterseniz:

1. Depoyu forklayın.
2. Yeni bir dal (branch) oluşturun: git checkout -b ozellik/yeni-ozellik
3. Değişikliklerinizi commit edin: git commit -m "feat: yeni özellik eklendi"
4. Dalınızı push edin: git push origin ozellik/yeni-ozellik
5. Pull request açın.

Kaynaklar

• GitHub Deposu: mehmetulukaya/muterm
• Free Pascal Wiki — Lazarus Communications Software: MUTerm
• Lazarus IDE: [https://www.lazarus-ide.org/](https://www.lazarus-ide.org/)
• Free Pascal: [https://www.freepascal.org/](https://www.freepascal.org/)

Son Not: Bu README, depodaki dosya yapısı, commit geçmişi ve proje açıklaması temel alınarak hazırlanmıştır. Proje hakkında daha fazla bilgi için yukarıdaki GitHub bağlantısını ziyaret edebilirsiniz.