소스 검색

docs: use ENCRYPTION_KEY in lock examples (#421)

* Fix ENCRYPTION_KEY var in README

Fixes var name being unabbreviated when defined.

* chore(pre-commit.ci): auto fixes

---------

Co-authored-by: zerzhang <916250497@qq.com>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Lenny. 2 일 전
부모
커밋
bd0c370921
1개의 변경된 파일과 8개의 추가작업 그리고 4개의 파일을 삭제
  1. 8 4
      README.md

+ 8 - 4
README.md

@@ -136,14 +136,16 @@ from switchbot.const import SwitchbotModel
 
 BLE_MAC = "XX:XX:XX:XX:XX:XX"  # The MAC of your lock
 KEY_ID = "XX"  # The key-ID of your encryption-key for your lock
-ENC_KEY = "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"  # The encryption-key with key-ID "XX"
+ENCRYPTION_KEY = (
+    "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"  # The encryption-key with key-ID "XX"
+)
 LOCK_MODEL = SwitchbotModel.LOCK_PRO  # Your lock model (here we use the Lock-Pro)
 
 
 async def main():
     wolock = await GetSwitchbotDevices().get_locks()
     await lock.SwitchbotLock(
-        wolock[BLE_MAC].device, KEY_ID, ENC_KEY, model=LOCK_MODEL
+        wolock[BLE_MAC].device, KEY_ID, ENCRYPTION_KEY, model=LOCK_MODEL
     ).unlock()
 
 
@@ -160,14 +162,16 @@ from switchbot.const import SwitchbotModel
 
 BLE_MAC = "XX:XX:XX:XX:XX:XX"  # The MAC of your lock
 KEY_ID = "XX"  # The key-ID of your encryption-key for your lock
-ENC_KEY = "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"  # The encryption-key with key-ID "XX"
+ENCRYPTION_KEY = (
+    "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"  # The encryption-key with key-ID "XX"
+)
 LOCK_MODEL = SwitchbotModel.LOCK_PRO  # Your lock model (here we use the Lock-Pro)
 
 
 async def main():
     wolock = await GetSwitchbotDevices().get_locks()
     await lock.SwitchbotLock(
-        wolock[BLE_MAC].device, KEY_ID, ENC_KEY, model=LOCK_MODEL
+        wolock[BLE_MAC].device, KEY_ID, ENCRYPTION_KEY, model=LOCK_MODEL
     ).lock()