Beranda>Terkait pemrograman>Kode sumber lainnya
Unduh

PyViCare

Library ini mengimplementasikan akses ke perangkat Viessmann dengan menggunakan API resmi dari Portal Pengembang Viessmann.

Perubahan yang merusak di versi 2.27.x

  • Beberapa kelas dasar telah diubah namanya untuk memberikan dukungan yang lebih baik untuk perangkat non-pemanas. Lihat PR #307

Perubahan yang merusak di versi 2.8.x

  • Sirkuit, burner (Gaz) dan kompresor (Heat Pump) kini terpisah. Mengakses properti burner/kompresor dipindahkan dari device.circuits ke device.burners dan device.compressor .

Melanggar perubahan di versi 2.x

  • API untuk mengakses perangkat Anda diubah menjadi kelas PyViCare umum. Gunakan kelas ini untuk memuat semua perangkat yang tersedia.
  • API untuk mengakses sirkuit pemanas perangkat telah dipindahkan ke kelas Device . Anda sekarang dapat mengakses dan mengulangi semua sirkuit yang tersedia melalui device.circuits . Hal ini memungkinkan untuk dengan mudah melihat properti mana yang bergantung pada sirkuit.

Lihat contoh di bawah untuk mengetahui bagaimana Anda dapat menggunakannya.

Melanggar perubahan di versi 1.x

  • Versi sebelum 1.x menggunakan API tidak resmi yang berhenti berfungsi pada 15 Juli 2021. Semua pengguna harus bermigrasi ke versi 1.0.0 untuk terus menggunakan API.
  • Pengecualian dimunculkan jika perpustakaan mencapai batas kecepatan API. (Lihat tanda fitur raise_exception_on_rate_limit )
  • Pengecualian muncul jika fitur perangkat yang tidak didukung digunakan. (Lihat tanda fitur raise_exception_on_not_supported_device_feature )
  • Python 3.4 tidak lagi didukung.
  • Python 3.9 sekarang didukung.

Prasyarat

Untuk menggunakan PyViCare, setiap pengguna harus mendaftar dan membuat klien API pribadinya. Ikuti langkah-langkah berikut untuk membuat klien Anda:

  1. Masuk ke Portal Pengembang Viessmann dengan nama pengguna/kata sandi aplikasi ViCare Anda .
  2. Di dasbor pengembang klik tambahkan di bagian klien .
  3. Buat klien baru menggunakan data berikut:
    • Nama: PyViCare
    • Google reCAPTCHA: Dinonaktifkan
    • Pengalihan URI: vicare://oauth-callback/everest
  4. Salin Client ID untuk digunakan dalam kode Anda. Meneruskannya sebagai parameter konstruktor ke perangkat.

Harap dicatat bahwa tidak semua properti dari versi lama dan aplikasi seluler ViCare tersedia di API baru. Properti yang hilang telah dihapus dan mungkin ditambahkan nanti jika tersedia kembali.

Membantu

Kami memerlukan bantuan untuk menguji dan meningkatkan PyViCare, karena pengelola hanya memiliki jenis sistem pemanas tertentu. Untuk bug, pertanyaan, atau permintaan fitur, bergabunglah dengan saluran PyViCare di Discord atau buat masalah di repositori ini.

Fitur/Kesalahan Perangkat

Tergantung pada perangkatnya, beberapa fitur tidak tersedia/didukung. Hal ini menyebabkan munculnya PyViCareNotSupportedFeatureError jika metode khusus dipanggil. Ini kemungkinan besar bukan bug, tetapi batasan dari perangkat itu sendiri.

Tip: Anda dapat menggunakan kontekslib.suppress Python untuk menanganinya dengan baik.

Jenis pemanas

  • Gunakan asGazBoiler untuk pemanas gas
  • Gunakan asHeatPump untuk pompa panas
  • Gunakan asFuelCell untuk sel bahan bakar
  • Gunakan asPelletsBoiler untuk pemanasan pelet
  • Gunakan asOilBoiler untuk pemanas minyak
  • Gunakan asHybridDevice untuk pemanas hibrid pompa gas/panas

Penggunaan Dasar: 

 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 ())

Penggunaan API di Tukang Pos

Ikuti langkah-langkah berikut untuk mengakses API di Postman:

  1. Buat token akses di tab Authorization dengan tipe OAuth 2.0 dan input berikut:

    • Nama Token: PyViCare
    • Jenis Hibah: Authorization Code (With PKCE)
    • URL panggilan balik: vicare://oauth-callback/everest
    • Otorisasi menggunakan browser: Dinonaktifkan
    • URL Otentikasi: https://iam.viessmann.com/idp/v3/authorize
    • Akses URL Token: https://iam.viessmann.com/idp/v3/token
    • ID Klien: ID Klien pribadi Anda yang dibuat di portal pengembang.
    • Rahasia Klien: Kosong
    • Metode Tantangan Kode: SHA-256
    • Pemverifikasi Kode: Kosong
    • Cakupan: IoT User
    • Negara: Kosong
    • Otentikasi Klien: Send client credentials in body .

    Popup login akan terbuka. Masukkan nama pengguna dan kata sandi ViCare Anda.

  2. Gunakan URL ini untuk installationId , gatewaySerial dan deviceId Anda :

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

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

  3. Gunakan data di atas untuk menggantikan {installationId} , {gatewaySerial} dan {deviceId} di URL ini untuk menyelidiki Viessmann API:

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

Batasan Tarif

Karena perubahan terbaru pada batas laju API Viessmann dapat tercapai. Dalam hal ini PyViCareRateLimitError dimunculkan. Anda dapat membaca kesalahan ( limitResetDate ) ketika batas kecepatan disetel ulang.

Diperlukan lebih banyak perangkat berbeda untuk kasus uji

Untuk membantu memastikan pembuatan lebih banyak kasus pengujian, Anda dapat menjalankan kode ini dan membuat permintaan penarikan dengan menambahkan pengujian baru untuk jenis perangkat Anda. Pengujian Anda harus dimasukkan ke dalam pengujian/respons dan diberi nama .

Kode yang harus dijalankan untuk mewujudkan hal ini ada di bawah. Ini secara otomatis menghapus informasi "sensitif" seperti id instalasi dan nomor seri. Anda dapat mengganti nilai default atau menggunakan variabel lingkungan 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 ())
Memperluas
Informasi Tambahan
Direkomendasikan untuk Anda
Informasi Terkait Semua