الصفحة الرئيسية>المتعلقة بالبرمجة>شفرة المصدر الأخرى
تنزيل

بايفيكير

تنفذ هذه المكتبة الوصول إلى أجهزة Viessmann باستخدام واجهة برمجة التطبيقات الرسمية من Viessmann Developer Portal.

تغييرات جذرية في الإصدار 2.27.x

  • تمت إعادة تسمية بعض الفئات الأساسية لتوفير دعم أفضل للأجهزة غير المخصصة للتدفئة. انظر العلاقات العامة رقم 307

تغييرات جذرية في الإصدار 2.8.x

  • تم الآن فصل الدائرة والموقد (الغاز) والضاغط (المضخة الحرارية). يتم نقل الوصول إلى خصائص الناسخ/الضاغط من device.circuits إلى device.burners و device.compressor .

كسر التغييرات في الإصدار 2.x

  • تم تغيير واجهة برمجة التطبيقات للوصول إلى جهازك إلى فئة PyViCare عامة. استخدم هذه الفئة لتحميل كافة الأجهزة المتوفرة.
  • انتقلت واجهة برمجة التطبيقات (API) للوصول إلى دائرة تسخين الجهاز إلى فئة Device . يمكنك الآن الوصول إلى جميع الدوائر المتاحة وتكرارها عبر device.circuits . يتيح ذلك معرفة الخصائص التي تعتمد على الدائرة بسهولة.

انظر المثال أدناه لمعرفة كيف يمكنك استخدام ذلك.

كسر التغييرات في الإصدار 1.x

  • استخدمت الإصدارات السابقة للإصدار 1.x واجهة برمجة تطبيقات غير رسمية توقفت عن العمل في 15 يوليو 2021. ويحتاج جميع المستخدمين إلى الانتقال إلى الإصدار 1.0.0 لمواصلة استخدام واجهة برمجة التطبيقات.
  • يتم رفع الاستثناء إذا وصلت المكتبة إلى حد معدل API. (راجع علامة الميزة raise_exception_on_rate_limit )
  • يتم رفع الاستثناء في حالة استخدام ميزة جهاز غير مدعومة. (راجع علامة الميزة raise_exception_on_not_supported_device_feature )
  • لم يعد Python 3.4 مدعومًا.
  • بايثون 3.9 مدعوم الآن.

المتطلبات الأساسية

لاستخدام PyViCare، يجب على كل مستخدم التسجيل وإنشاء عميل API الشخصي الخاص به. اتبع الخطوات التالية لإنشاء عميلك:

  1. قم بتسجيل الدخول إلى Viessmann Developer Portal باستخدام اسم المستخدم/كلمة المرور الحالية لتطبيق ViCare .
  2. في لوحة تحكم المطور، انقر فوق "إضافة" في قسم العملاء .
  3. قم بإنشاء عميل جديد باستخدام البيانات التالية:
    • الاسم: بيفي كير
    • Google reCAPTCHA: معطل
    • إعادة توجيه عناوين URI: vicare://oauth-callback/everest
  4. انسخ Client ID لاستخدامه في التعليمات البرمجية الخاصة بك. قم بتمريرها كمعلمة منشئ إلى الجهاز.

يرجى ملاحظة أنه ليست كل الخصائص من الإصدارات الأقدم وتطبيق ViCare للجوال متوفرة في واجهة برمجة التطبيقات الجديدة. تمت إزالة الخصائص المفقودة وقد تتم إضافتها لاحقًا إذا كانت متوفرة مرة أخرى.

يساعد

نحتاج إلى مساعدة في اختبار PyViCare وتحسينه، نظرًا لأن المشرفين لديهم أنواع محددة فقط من أنظمة التدفئة. بالنسبة للأخطاء أو الأسئلة أو طلبات الميزات، انضم إلى قناة PyViCare على Discord أو قم بإنشاء مشكلة في هذا المستودع.

ميزات الجهاز / الأخطاء

اعتمادًا على الجهاز، لا تتوفر/تدعم بعض الميزات. يؤدي هذا إلى ظهور خطأ PyViCareNotSupportedFeatureError إذا تم استدعاء الطريقة المخصصة. وهذا على الأرجح ليس خطأً، بل هو قيد على الجهاز نفسه.

نصيحة: يمكنك استخدام Pythons contextlib.suppress للتعامل معها بأمان.

أنواع التدفئة

  • استخدم asGazBoiler لتسخين الغاز
  • استخدم asHeatPump حرارية للمضخات الحرارية
  • استخدم asFuelCell الوقود لخلايا الوقود
  • استخدم asPelletsBoiler لتسخين الكريات
  • استخدم asOilBoiler لتسخين الزيت
  • استخدم asHybridDevice للتسخين الهجين لمضخة الغاز/الحرارة

الاستخدام الأساسي: 

 import sys
import logging
from PyViCare . PyViCare import PyViCare

client_id = "INSERT CLIENT ID"
email = "email@domain"
password = "password"

vicare = PyViCare ()
vicare . initWithCredentials ( email , password , client_id , "token.save" )
device = vicare . devices [ 0 ]
print ( device . getModel ())
print ( "Online" if device . isOnline () else "Offline" )

t = device . asAutoDetectDevice ()
print ( t . getDomesticHotWaterConfiguredTemperature ())
print ( t . getDomesticHotWaterStorageTemperature ())
print ( t . getOutsideTemperature ())
print ( t . getRoomTemperature ())
print ( t . getBoilerTemperature ())
print ( t . setDomesticHotWaterTemperature ( 59 ))

circuit = t . circuits [ 0 ] #select heating circuit

print ( circuit . getSupplyTemperature ())
print ( circuit . getHeatingCurveShift ())
print ( circuit . getHeatingCurveSlope ())

print ( circuit . getActiveProgram ())
print ( circuit . getPrograms ())

print ( circuit . getCurrentDesiredTemperature ())
print ( circuit . getDesiredTemperatureForProgram ( "comfort" ))
print ( circuit . getActiveMode ())

print ( circuit . getDesiredTemperatureForProgram ( "comfort" ))
print ( circuit . setProgramTemperature ( "comfort" , 21 ))
print ( circuit . activateProgram ( "comfort" ))
print ( circuit . deactivateComfort ())

burner = t . burners [ 0 ] #select burner
print ( burner . getActive ())

compressor = t . compressors [ 0 ] #select compressor
print ( compressor . getActive ())

استخدام API في ساعي البريد

اتبع هذه الخطوات للوصول إلى واجهة برمجة التطبيقات في Postman:

  1. قم بإنشاء رمز وصول في علامة التبويب Authorization بنوع OAuth 2.0 والمدخلات التالية:

    • اسم الرمز المميز: PyViCare
    • نوع المنحة: Authorization Code (With PKCE)
    • عنوان URL لرد الاتصال: vicare://oauth-callback/everest
    • التفويض باستخدام المتصفح: معطل
    • عنوان URL للمصادقة: https://iam.viessmann.com/idp/v3/authorize
    • عنوان URL لرمز الوصول: https://iam.viessmann.com/idp/v3/token
    • معرف العميل: معرف العميل الشخصي الخاص بك الذي تم إنشاؤه في بوابة المطور.
    • سر العميل: فارغ
    • طريقة تحدي الكود: SHA-256
    • أداة التحقق من الرمز: فارغة
    • النطاق: IoT User
    • الدولة: فارغة
    • مصادقة العميل: Send client credentials in body .

    سيتم فتح نافذة منبثقة لتسجيل الدخول. أدخل اسم المستخدم وكلمة المرور الخاصين بـ ViCare.

  2. استخدم عنوان URL هذا للوصول إلى installationId gatewaySerial ومعرف deviceId :

    https://api.viessmann.com/iot/v1/equipment/installations?includeGateways=true

    • installationId هو data[0].id
    • gatewaySerial هو data[0].gateways[0].serial
    • deviceId هو data[0].gateways[0].devices[0].id

  3. استخدم البيانات المذكورة أعلاه لاستبدال {installationId} و {gatewaySerial} و {deviceId} في عنوان URL هذا للتحقق من واجهة برمجة تطبيقات Viessmann:

    https://api.viessmann.com/iot/v1/features/installations/{installationId}/gateways/{gatewaySerial}/devices/{deviceId}/features

حدود المعدل

نظرًا للتغييرات الأخيرة في حدود معدل Viessmann API، يمكن الوصول إليها. في هذه الحالة يتم رفع الخطأ PyViCareRateLimitError . يمكنك القراءة من الخطأ ( limitResetDate ) عند إعادة تعيين حد السعر.

هناك حاجة إلى المزيد من الأجهزة المختلفة لحالات الاختبار

للمساعدة في ضمان تسهيل إنشاء المزيد من حالات الاختبار، يمكنك تشغيل هذا الرمز وتقديم طلب سحب مع إضافة الاختبار الجديد لنوع جهازك. يجب أن يُلتزم الاختبار الخاص بك بالاختبارات/الاستجابة ويُسمى .

الكود المطلوب تشغيله لتحقيق ذلك موجود أدناه. يؤدي هذا تلقائيًا إلى إزالة المعلومات "الحساسة" مثل معرف التثبيت والأرقام التسلسلية. يمكنك إما استبدال القيم الافتراضية أو استخدام متغيرات البيئة PYVICARE_* . 

 import sys
import os
from PyViCare . PyViCare import PyViCare

client_id = os . getenv ( "PYVICARE_CLIENT_ID" , "INSERT CLIENT_ID" )
email = os . getenv ( "PYVICARE_EMAIL" , "email@domain" )
password = os . getenv ( "PYVICARE_PASSWORD" , "password" )

vicare = PyViCare ()
vicare . initWithCredentials ( email , password , client_id , "token.save" )

with open ( f"dump.json" , mode = 'w' ) as output :
   output . write ( vicare . devices [ 0 ]. dump_secure ())
يوسع
معلومات إضافية
نوصي لك
أخبار ذات صلة الكل