README is not telling how to send a BLE command

[dr-ni]

Please add a description or some examples (for switchbot, lock pro, ...) to completely show the process for a cloud-free usage of switchbot devices.
This nice repo is rather useless without any documentation about the most important steps...

[dr-ni]

Is this the correct usage?

import asyncio
from switchbot.discovery import GetSwitchbotDevices
from switchbot.devices import lock

async def main():
    wolock = await GetSwitchbotDevices().get_locks()
    print()
    print(wolock)
    print()
    await lock.SwitchbotLock(wolock["<ble-mac>"].device, "<key-id>", "<encryption-key>").lock()
    await lock.SwitchbotLock(wolock["<ble-mac>"].device, "<key-id>", "<encryption-key>").unlock()

asyncio.run(main())

[dr-ni]

The above unlock command is also locking my lock pro?
So I cannot unlock. Is this a bug?

See also #312

[dr-ni]

Some more news:

I could get it working after changing the following lines of lock.py like this

...
...
COMMAND_HEADER = "57"
COMMAND_LOCK_INFO = {
    SwitchbotModel.LOCK: f"{COMMAND_HEADER}0f4f8101",
    SwitchbotModel.LOCK_PRO: f"{COMMAND_HEADER}0f4f8102",
}
COMMAND_UNLOCK = {
#    SwitchbotModel.LOCK:     f"{COMMAND_HEADER}0f4e01011080",
    SwitchbotModel.LOCK: f"{COMMAND_HEADER}0f4e0101000080",
}
COMMAND_UNLOCK_WITHOUT_UNLATCH = {
#    SwitchbotModel.LOCK: f"{COMMAND_HEADER}0f4e010110a0",
#    SwitchbotModel.LOCK_PRO: f"{COMMAND_HEADER}0f4e01010000a0",
}
COMMAND_LOCK = {
#    SwitchbotModel.LOCK: f"{COMMAND_HEADER}0f4e01011000",
    SwitchbotModel.LOCK: f"{COMMAND_HEADER}0f4e0101000000",
}
...
...

and got the following output:

uwe@rp5:~/pySwitchbot $ bin/python3 test_lock.py
# Found Lock:
{'XX:XX:XX:XX:XX:XX': SwitchBotAdvertisement(address='XX:XX:XX:XX:XX:XX', data={'rawAdvData': b'$\x80a', 'data': {'battery': 97, 'calibration': True, 'status': <LockStatus.UNLOCKED: 1>, 'door_open': True, 'update_from_secondary_lock': False, 'double_lock_mode': False, 'unclosed_alarm': False, 'unlocked_alarm': False, 'auto_lock_paused': True, 'night_latch': False}, 'model': '$', 'isEncrypted': False, 'modelFriendlyName': 'Lock Pro', 'modelName': <SwitchbotModel.LOCK_PRO: 'WoLockPro'>}, device=BLEDevice(XX:XX:XX:XX:XX:XX, Lock Pro), rssi=-38, active=True)}

uwe@rp5:~/pySwitchbot $ bin/python3 lock.py
# Found Lock:
{'XX:XX:XX:XX:XX:XX': SwitchBotAdvertisement(address='XX:XX:XX:XX:XX:XX', data={'rawAdvData': b'$\x80a', 'data': {'battery': 97, 'calibration': True, 'status': <LockStatus.UNLOCKED: 1>, 'door_open': True, 'update_from_secondary_lock': False, 'double_lock_mode': False, 'unclosed_alarm': False, 'unlocked_alarm': False, 'auto_lock_paused': True, 'night_latch': False}, 'model': '$', 'isEncrypted': False, 'modelFriendlyName': 'Lock Pro', 'modelName': <SwitchbotModel.LOCK_PRO: 'WoLockPro'>}, device=BLEDevice(XX:XX:XX:XX:XX:XX, Lock Pro), rssi=-31, active=True)}

/home/uwe/pySwitchbot/switchbot/devices/device.py:292: FutureWarning: BLEDevice.rssi is deprecated and will be removed in a future version of Bleak, use AdvertisementData.rssi instead
  return self._device.rssi
/home/uwe/pySwitchbot/switchbot/devices/device.py:292: FutureWarning: BLEDevice.rssi is deprecated and will be removed in a future version of Bleak, use AdvertisementData.rssi instead
  return self._device.rssi
Unsuccessful, please try again
No advertisement data to update
NoneType: None
uwe@rp5:~/pySwitchbot $ bin/python3 unlock.py
# Found Lock:
{'XX:XX:XX:XX:XX:XX': SwitchBotAdvertisement(address='XX:XX:XX:XX:XX:XX', data={'rawAdvData': b'$\x80a', 'data': {'battery': 97, 'calibration': True, 'status': <LockStatus.LOCKED: 0>, 'door_open': True, 'update_from_secondary_lock': False, 'double_lock_mode': False, 'unclosed_alarm': False, 'unlocked_alarm': False, 'auto_lock_paused': True, 'night_latch': False}, 'model': '$', 'isEncrypted': False, 'modelFriendlyName': 'Lock Pro', 'modelName': <SwitchbotModel.LOCK_PRO: 'WoLockPro'>}, device=BLEDevice(XX:XX:XX:XX:XX:XX, Lock Pro), rssi=-28, active=True)}

/home/uwe/pySwitchbot/switchbot/devices/device.py:292: FutureWarning: BLEDevice.rssi is deprecated and will be removed in a future version of Bleak, use AdvertisementData.rssi instead
  return self._device.rssi
/home/uwe/pySwitchbot/switchbot/devices/device.py:292: FutureWarning: BLEDevice.rssi is deprecated and will be removed in a future version of Bleak, use AdvertisementData.rssi instead
  return self._device.rssi
Unsuccessful, please try again
No advertisement data to update
NoneType: None
uwe@rp5:~/pySwitchbot $ bin/python3 test_lock.py
# Found Lock:
{'XX:XX:XX:XX:XX:XX': SwitchBotAdvertisement(address='XX:XX:XX:XX:XX:XX', data={'rawAdvData': b'$\x80a', 'data': {'battery': 97, 'calibration': True, 'status': <LockStatus.UNLOCKED: 1>, 'door_open': True, 'update_from_secondary_lock': False, 'double_lock_mode': False, 'unclosed_alarm': False, 'unlocked_alarm': False, 'auto_lock_paused': True, 'night_latch': False}, 'model': '$', 'isEncrypted': False, 'modelFriendlyName': 'Lock Pro', 'modelName': <SwitchbotModel.LOCK_PRO: 'WoLockPro'>}, device=BLEDevice(XX:XX:XX:XX:XX:XX, Lock Pro), rssi=-31, active=True)}

[dr-ni]

This shows me that instead of SwitchbotModel.LOCK_PRO the SwitchbotModel.LOCK is used - although that wolock has the correct 'modelName': <SwitchbotModel.LOCK_PRO of my Lock-Pro. And also wolock has 'night_latch': False but COMMAND_UNLOCK is used instead of COMMAND_UNLOCK_WITHOUT_UNLATCH.

So i guess I have to send my commands in a different way, isn't it?

[mjoops]

Switchbot lock is defaultly initialize as LOCK not LOCK_PRO.

def __init__(
        self,
        device: BLEDevice,
        key_id: str,
        encryption_key: str,
        interface: int = 0,
        model: SwitchbotModel = SwitchbotModel.LOCK,
        **kwargs: Any,
    )

So if you want correctly initialized lock object as lock pro you need to set the model argument.

await lock.SwitchbotLock(wolock["<ble-mac>"].device, "<key-id>", "<encryption-key>", model=SwitchbotModel.LOCK_PRO).unlock()

COMMAND_UNLOCK_WITHOUT_UNLATCH

This command is only for unlocking the lock, witch has enabled night latch feature, without retracting the latch. Automatic discover, if night latch is enabled, only works on older lock not the lock pro so it set always to False, but the command works correctly. The logic to find if unlock or unlock_without_unlatch should be used must be implemented by consumer. For example in HomeAssitent there is a option to tell HA that your lock has this feature enabled manually. #247

[dr-ni]

I'm getting now from

    await lock.SwitchbotLock(
        wolock[BLE_MAC].device, KEY_ID, ENCRYPTION_KEY, model=SwitchbotModel.LOCK_PRO
    ).lock()

NameError: name 'SwitchbotModel' is not defined

[mjoops]

Did you import it?
from switchbot.const import SwitchbotModel

[dr-ni]

ok this import was missing

[dr-ni]

see #312