Functions SDK

Fonksiyon, Proxus'un derleyip seçtiğiniz Edge Gateway'lerde çalıştırdığı bir C# sınıfıdır. Edge Gateway'in okuduğu değerleri alır, bu değerleri değiştirebilir veya yeni değerler ekleyebilir. Ayrıca değer kaydedebilir, başka sistemleri çağırabilir ve bildirim gönderebilir. Bu sayfa programlama arayüzünü anlatır. Merkez sunucuda fonksiyon oluşturma, derleme ve dağıtma adımları için Fonksiyonlar sayfasına bakın.

Bir fonksiyonun yapısı

Fonksiyon, FunctionBase sınıfından türetilen tek bir sınıftır. Kurucusundaki üç parametreyi olduğu gibi temel sınıfa aktarır. Edge Gateway, fonksiyon dağıtıldığında sınıftan bir kez örnek oluşturur. Fonksiyon kaldırıldığında veya yeniden dağıtıldığında bu örneği durdurur.

using System;
using Proxus.Common;
using Proxus.Common.Messages;
using Proxus.SDK.BaseFunctions;

namespace Proxus.Functions {

// Koli paketleme makinelerinin her okumasına hesaplanan bir veri noktası ekler ve motor akımı yüksek olduğunda uyarır.
public sealed class PackerPowerFunction(object sys, object log, object config) : FunctionBase(sys, log, config) {

    private const double CurrentLimit = 45.0;          // A
    private const string ChannelName = "Shift supervisors";
    private DateTime _lastWarning = DateTime.MinValue;

    protected override void OnStarted() {
        // Bu Edge Gateway'deki tüm cihazların okumalarını alır. Daraltmak için "*" yerine cihaz ID'leri yazın.
        Subscriptions?.Add(new SubscriptionContext {
            Type = typeof(TransportData),
            Topics = ["*"]
        });

        // Her dakika fonksiyon günlüğüne bir yaşam sinyali yazar.
        ExecuteScheduledTask(TimeSpan.FromMinutes(1), () => LogInformation("PackerPowerFunction is running"));

        base.OnStarted();
    }

    protected override void OnMessageReceive(FunctionContext ctx) {
        if (ctx.Message is not TransportData data) return;

        var deviceName = data.GetMetaDataValueByKey("DeviceName") ?? ctx.Topic;
        if (!deviceName.StartsWith("LYS_PACKER_", StringComparison.Ordinal)) return;

        var current = data.GetPayloadValueByName<double>("MotorCurrent");
        if (current <= 0) return;

        // Aynı okumaya yeni bir veri noktası eklenir. Bu değer, makineden okunan bir değer gibi saklanır ve yayınlanır.
        var powerKw = Math.Round(400 * current * Math.Sqrt(3) * 0.85 / 1000, 2);
        data.SetPayloadValue("MotorPower", powerKw, "kW");

        if (current > CurrentLimit && DateTime.UtcNow - _lastWarning > TimeSpan.FromMinutes(10)) {
            _lastWarning = DateTime.UtcNow;
            LogWarning($"{deviceName}: motor current {current} A is above {CurrentLimit} A");
            SendNotification(ChannelName, $"{deviceName}: motor current {current} A is above {CurrentLimit} A");
        }
    }
}
}

Edge Gateway'in fonksiyonları çalıştırma biçimi nedeniyle şu kurallara uyun:

• Aboneliklerinizi OnStarted içinde ekleyin ve ardından base.OnStarted() yöntemini çağırın. Abonelikleri temel yöntem bağlar. Bu çağrıdan sonra eklenen abonelikler veri almaz.
• OnMessageReceive her okuma için çağrılır. Bu çağrı okuma saklanmadan, veri hedeflerine gönderilmeden ve işlem akışlarından geçmeden önce yapılır. TransportData nesnesine eklediğiniz veya nesnede değiştirdiğiniz veri içeriği, okumayla birlikte işlenmeye devam eder.
• Fonksiyonun kendi ürettiği okumalar (BackToPipeline, Save) fonksiyonlara tekrar gönderilmez. Böylece bir fonksiyon kendi çıktısıyla sonsuz döngüye girmez.
• OnMessageReceive yöntemini kısa tutun. HTTP çağrısı veya veritabanı sorgusu gibi uzun işleri ayrı bir görev olarak başlatın ve sonucunu beklemeyin.

Yaşam döngüsü

FunctionContext iki alan içerir: Topic (cihaz verisinde cihazın ID'si) ve Message (alınan nesne, genellikle bir TransportData).

Abonelikler

Subscriptions?.Add(new SubscriptionContext {
    Type = typeof(TransportData),
    Topics = ["69", "70"],       // cihaz ID'leri veya Edge Gateway'deki her cihaz için "*"
    EdgeGateways = ["2"]         // isteğe bağlı: 2 numaralı Edge Gateway'in PublishToEdgeGateways ile yayınladıklarını da al
});

Okumadaki değerleri alma ve değiştirme

Her okuma bir TransportData nesnesidir. İçinde iki liste bulunur: her veri noktası için bir Payload ve okumaya ait bilgileri taşıyan MetaData. DeviceId, DeviceName, Enterprise, Site, Area, ProcessCell ve EquipmentModule bu bilgilere örnektir.

Payload nesnesi Key, Value (metin), NumericValue, Type, Unit ve Time alanlarını içerir.

Veriyi gönderme

MQTT yardımcıları, geçersiz kılınabilen dört özellikte tanımlı MQTT sunucusuna bağlanır: MqttBrokerHost (varsayılan "localhost"), MqttBrokerPort (1883), MqttBrokerUser ve MqttBrokerPassword (boş). Başka bir MQTT sunucusuna bağlanmak için bu özellikleri geçersiz kılın. Edge Gateway'in yerleşik MQTT sunucusunu kullanmak için MqttBrokerUser özelliğine Edge Gateway'in MasterToken değerini verin.

Cihazlar, bildirimler ve veritabanları

Zamanlayıcılar

Bu yöntemlerle başlatılan zamanlayıcılar, fonksiyon durduğunda otomatik olarak durdurulur.

Günlükler ve hatalar

LogTrace, LogDebug, LogInformation, LogWarning, LogError ve LogCritical yöntemlerinin tümü (object message, bool asJson = false) parametrelerini alır. Yazılan satırlar, fonksiyonun Günlükler bölümünde ve Sistem günlükleri ekranında, başında sınıf adıyla görünür.

Edge Gateway'in yapılandırmasında [UserFunctions] bölümündeki ayarlar, hatalı çalışan bir fonksiyonun etkisini sınırlar:

Çağrı başına süre veya bellek sınırı yoktur. Takılan ya da döngüye giren bir fonksiyon, abone olduğu cihazların verisinin Edge Gateway'de işlenmesini bekletir. Bu nedenle OnMessageReceive içindeki işi küçük tutun.

Derleyicinin sundukları

Kodunuzda .NET temel kütüphanesini (koleksiyonlar, LINQ, görevler, HttpClient, soketler, JSON, XML), yukarıda anlatılan Proxus türlerini, MQTT istemci türlerini ve ML.NET'i kullanabilirsiniz. Paket yöneticisi yoktur. Bu kümenin dışındaki kütüphanelere başvuru eklenemez.

Güvenlik nedeniyle aşağıdaki namespace'leri kullanan kod derlenmez ve Blacklisted namespace used: <name>. Reason: ... mesajıyla reddedilir:

Derleme hataları <code> (line <n>, column <n>): <message> biçiminde listelenir.

Şablonlar

Fonksiyon ekranındaki Şablonlar ile yeni bir fonksiyonu aşağıdaki şablonlardan biriyle başlatabilirsiniz:

Sonraki adımlar

• Fonksiyonlar: merkez sunucuda fonksiyon oluşturun, derleyin, dağıtın ve günlüklerini inceleyin.
• İşlem akışları ve alarm kuralları: hangi durumda fonksiyon, hangi durumda işlem akışı veya alarm kuralı kullanılacağını öğrenin.
• Otomasyon sorunlarını giderme: derleme ve dağıtım hatalarını çözün.