หน้าแรก>การเขียนโปรแกรมที่เกี่ยวข้อง>ซอร์สโค้ดอื่น ๆ
ดาวน์โหลด

PyViCare

ไลบรารีนี้ใช้การเข้าถึงอุปกรณ์ Viessmann โดยใช้ API อย่างเป็นทางการจาก Viessmann Developer Portal

การเปลี่ยนแปลงในเวอร์ชัน 2.27.x

  • คลาสพื้นฐานบางคลาสได้รับการเปลี่ยนชื่อเพื่อให้รองรับอุปกรณ์ที่ไม่มีความร้อนได้ดียิ่งขึ้น ดูประชาสัมพันธ์ #307

การเปลี่ยนแปลงในเวอร์ชัน 2.8.x

  • ตอนนี้วงจรหัวเผา (Gaz) และคอมเพรสเซอร์ (Heat Pump) แยกออกจากกันแล้ว การเข้าถึงคุณสมบัติของเครื่องเขียน/คอมเพรสเซอร์จะถูกย้ายจาก device.circuits ไปยัง device.burners และ device.compressor

การเปลี่ยนแปลงในเวอร์ชัน 2.x

  • API เพื่อเข้าถึงอุปกรณ์ของคุณเปลี่ยนเป็นคลาส PyViCare ทั่วไป ใช้คลาสนี้เพื่อโหลดอุปกรณ์ที่มีอยู่ทั้งหมด
  • API สำหรับเข้าถึงวงจรทำความร้อนของอุปกรณ์ได้ย้ายไปที่คลาส Device แล้ว ตอนนี้คุณสามารถเข้าถึงและวนซ้ำวงจรที่มีอยู่ทั้งหมดผ่าน device.circuits ช่วยให้เห็นได้ง่ายว่าคุณสมบัติใดขึ้นอยู่กับวงจร

ดูตัวอย่างด้านล่างเพื่อดูว่าคุณใช้งานอย่างไร

การเปลี่ยนแปลงในเวอร์ชัน 1.x

  • เวอร์ชันก่อน 1.x ใช้ API อย่างไม่เป็นทางการซึ่งหยุดทำงานในวันที่ 15 กรกฎาคม 2021 ผู้ใช้ทุกคนจำเป็นต้องย้ายไปยังเวอร์ชัน 1.0.0 เพื่อใช้ API ต่อไป
  • ข้อยกเว้นจะเกิดขึ้นหากไลบรารีทำงานถึงขีดจำกัดอัตรา API (ดูแฟล็กคุณลักษณะ raise_exception_on_rate_limit )
  • ข้อยกเว้นจะเกิดขึ้นหากใช้ฟีเจอร์ของอุปกรณ์ที่ไม่รองรับ (ดูแฟล็กคุณลักษณะ raise_exception_on_not_supported_device_feature )
  • ไม่รองรับ Python 3.4 อีกต่อไป
  • รองรับ Python 3.9 แล้ว

ข้อกำหนดเบื้องต้น

หากต้องการใช้ PyViCare ผู้ใช้ทุกคนจะต้องลงทะเบียนและสร้างไคลเอนต์ API ส่วนตัวของตน ทำตามขั้นตอนเหล่านี้เพื่อสร้างลูกค้าของคุณ:

  1. เข้าสู่ระบบพอร์ทัลนักพัฒนา Viessmann ด้วย ชื่อผู้ใช้/รหัสผ่านแอป ViCare ที่คุณมีอยู่
  2. บนแดชบอร์ดนักพัฒนาซอฟต์แวร์ คลิก เพิ่ม ในส่วน ลูกค้า
  3. สร้างไคลเอนต์ใหม่โดยใช้ข้อมูลต่อไปนี้:
    • ชื่อ: PyViCare
    • Google reCAPTCHA: ปิดการใช้งาน
    • URI เปลี่ยนเส้นทาง: vicare://oauth-callback/everest
  4. คัดลอก Client ID เพื่อใช้ในโค้ดของคุณ ส่งผ่านเป็นพารามิเตอร์ตัวสร้างไปยังอุปกรณ์

โปรดทราบว่าคุณสมบัติบางอย่างจากเวอร์ชันเก่าและแอปมือถือ ViCare อาจไม่มีให้ใช้งานใน API ใหม่ คุณสมบัติที่ขาดหายไปจะถูกลบออกและอาจถูกเพิ่มในภายหลังหากมีให้บริการอีกครั้ง

ช่วย

เราต้องการความช่วยเหลือในการทดสอบและปรับปรุง 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 ในบุรุษไปรษณีย์

ทำตามขั้นตอนเหล่านี้เพื่อเข้าถึง API ในบุรุษไปรษณีย์:

  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 API:

    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 ())
ขยาย
ข้อมูลเพิ่มเติม
แนะนำสำหรับคุณ
ข้อมูลที่เกี่ยวข้อง ทั้งหมด