The BLE (Bluetooth Low Energy) lock communicator provides means to communicate with Tapkey locks via BLE. It can be used to send commands to locks.

Use TKMServiceFactory to retrieve an instance of BleLockCommunicator.

  • Executes a command on the specified lock. This method takes a command function that uses the TKMCommandExecutionFacade and executes it on the Tapkey lock with the specified Bluetooth address. To ensure that the device at the specified Bluetooth address is the intended Tapkey lock, the lock’s physical lock ID can be passed and will be validated before executing the command. In case verification fails, the returned Promise will resolve to null. Verifying the lock’s ID does not impose a runtime penalty.


    • TKMRuntimeError.bleInconsistencyError: The returned promise rejects will reject with this error when the bluetooth chip of the lock behaves in an unexpected way. This should not happen generally. But iOS is known to cache some bluetooth connection related configurations. When a configutation was recently changed by a firmware upgrade of a lock, this error might happen. This will be a permanent error and can not be solved by executing the command again. In this case a restart of the iPhone might help.