witte-mobile-mobile-library-for-objc
The WITTE Mobile Library for Objective-C provides additional classes and methods to further assist with the integration of the WITTE backend and the Tapkey SDK in the scope of a mobile app.
Features
- flinkey Box ID conversion: Convert flinkey Box IDs to physical lock IDs format and vice versa.
- flinkey Box feedback interpretation: Parse and interpret the 10 byte box feedback in order to determine if the box ahs been opened or closed.
Getting Started
Constants
/**
* The tenant id used with the Tapkey backend.
*/
FOUNDATION_EXPORT NSString* const WD_TENANT_ID;
/**
* The id token type used to authenticate with the Tapkey backend.
*/
FOUNDATION_EXPORT NSString* const WD_IP_ID;
/**
* The Bluetooth LE service UUID of a flinkey box.
*/
FOUNDATION_EXPORT NSString* const WD_BLE_SERIVCE_UUID;
/**
* The Bluetooth LE advertising format for flinkey box 2.4.
*/
FOUNDATION_EXPORT NSString* const WD_BLE_ADVERTISING_FORMAT_V1;
/**
* The Bluetooth LE advertising format for flinkey box 3.3.
*/
FOUNDATION_EXPORT int const WD_BLE_ADVERTISING_FORMAT_V2;flinkey Box ID conversion
A flinkey box is identified by a box ID or a physical Lock ID which basically is just another representation of a box ID. The box ID is actually printed on the box an consists of 4 groups of hexadecimal numbers (e.g. C1-08-F0-94). The physical lock ID is an encoded version of the box Id(e.g. BADBCPCU) which is used in the API fo the Tapkey Mobile Library. This library provides method to convert between both representations.
Box ID to physical lock ID
#import "WDBoxIdConverter.h"
#import "WDByteUtils.h"
NSString* const BoxId = @"C1-08-F0-94";
WDBoxIdConverter* converter = [[WDBoxIdConverter alloc]init];
NSString* physicalLockId = [converter toPhysicalLockIdWithBoxId:BoxId];Physical lock ID to box ID
#import "WDBoxIdConverter.h"
#import "WDByteUtils.h"
NSString* const PhysicalLockId = @"BADBCPCU";
WDBoxIdConverter* converter = [[WDBoxIdConverter alloc]init];
NSString* boxId = [converter toBoxIdWithPhysicalLockId:PhysicalLockId];Box feedback interpretation
In order to determine if the box has been opened or closed one needs to evaluate the 10 byte box feedback that is part of the result of a triggerLockAsync method call. This library provides a parser for the 10 byte box feedback that allows to determine the state of the box.
#import "WDBoxFeedback.h"
#import "WDByteUtils.h"
NSString* const str = @"4C420FFA5008003700D8";
NSData* data = [WDByteUtils toByteArray:str];
WDBoxFeedback* boxFeedback = [[WDBoxFeedback alloc]initWithResponseData:data];
if(boxFeedback.boxState == WDBoxStateLocked) {
// the box has been locked
}
else if(boxFeedback.boxState == WDBoxStateUnlocked) {
// the box has been opened
}
else if(boxFeedback.boxState == WDBoxStateDrawerOpen) {
// the drawer of the box is opened
}