Rename SKBeacon -> SKiBeaconProximity; Support both Major and Minor

minoskt · minoskt · commit c060a239fc0d · 2015-08-20T21:52:40.000+01:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,14 +1,15 @@
 # Changelog
 
 ### Next
-	- Renamed Proximity sensor to Beacon.
+	- Rename Proximity sensor to iBeaconProximity.
+	- Further improvements in iBeacon Proximity Sensing.
 
 ### 0.1.2
   - Fix crash with error message “SensorModule is already registered”.
 
 ### 0.1.1
-  - Support csv format in sensor data
-  - Fix crash when deregistering multiple sensors modules
+  - Support csv format in sensor data.
+  - Fix crash when deregistering multiple sensors modules.
 
 ### 0.1.0
-  - Initial Release
+  - Initial Release.
diff --git a/SensingKit.xcodeproj/project.pbxproj b/SensingKit.xcodeproj/project.pbxproj
@@ -64,7 +64,7 @@
 		CFBB415419B92514002AE1A9 /* InfoPlist.strings in Resources */ = {isa = PBXBuildFile; fileRef = CFBB415219B92514002AE1A9 /* InfoPlist.strings */; };
 		CFBB415619B92514002AE1A9 /* SensingKitTests.m in Sources */ = {isa = PBXBuildFile; fileRef = CFBB415519B92514002AE1A9 /* SensingKitTests.m */; };
 		CFBB416719B928C2002AE1A9 /* SKBattery.m in Sources */ = {isa = PBXBuildFile; fileRef = CFBB416019B928C2002AE1A9 /* SKBattery.m */; };
-		CFBB416819B928C2002AE1A9 /* SKBeacon.m in Sources */ = {isa = PBXBuildFile; fileRef = CFBB416219B928C2002AE1A9 /* SKBeacon.m */; };
+		CFBB416819B928C2002AE1A9 /* SKiBeaconProximity.m in Sources */ = {isa = PBXBuildFile; fileRef = CFBB416219B928C2002AE1A9 /* SKiBeaconProximity.m */; };
 		CFBB416919B928C2002AE1A9 /* SKLocation.m in Sources */ = {isa = PBXBuildFile; fileRef = CFBB416419B928C2002AE1A9 /* SKLocation.m */; };
 /* End PBXBuildFile section */
 
@@ -161,8 +161,8 @@
 		CFBB415519B92514002AE1A9 /* SensingKitTests.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = SensingKitTests.m; sourceTree = "<group>"; };
 		CFBB415F19B928C2002AE1A9 /* SKBattery.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = SKBattery.h; sourceTree = "<group>"; };
 		CFBB416019B928C2002AE1A9 /* SKBattery.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = SKBattery.m; sourceTree = "<group>"; };
-		CFBB416119B928C2002AE1A9 /* SKBeacon.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = SKBeacon.h; sourceTree = "<group>"; };
-		CFBB416219B928C2002AE1A9 /* SKBeacon.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = SKBeacon.m; sourceTree = "<group>"; };
+		CFBB416119B928C2002AE1A9 /* SKiBeaconProximity.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = SKiBeaconProximity.h; sourceTree = "<group>"; };
+		CFBB416219B928C2002AE1A9 /* SKiBeaconProximity.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = SKiBeaconProximity.m; sourceTree = "<group>"; };
 		CFBB416319B928C2002AE1A9 /* SKLocation.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = SKLocation.h; sourceTree = "<group>"; };
 		CFBB416419B928C2002AE1A9 /* SKLocation.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = SKLocation.m; sourceTree = "<group>"; };
 /* End PBXFileReference section */
@@ -313,8 +313,8 @@
 				CFBB416019B928C2002AE1A9 /* SKBattery.m */,
 				CFBB416319B928C2002AE1A9 /* SKLocation.h */,
 				CFBB416419B928C2002AE1A9 /* SKLocation.m */,
-				CFBB416119B928C2002AE1A9 /* SKBeacon.h */,
-				CFBB416219B928C2002AE1A9 /* SKBeacon.m */,
+				CFBB416119B928C2002AE1A9 /* SKiBeaconProximity.h */,
+				CFBB416219B928C2002AE1A9 /* SKiBeaconProximity.m */,
 			);
 			name = SensorModules;
 			sourceTree = "<group>";
@@ -446,7 +446,7 @@
 				CFB0D9491B5268FC00A7982B /* SKGyroscopeData.m in Sources */,
 				CFBB416919B928C2002AE1A9 /* SKLocation.m in Sources */,
 				CFB0D93D1B4FFA1D00A7982B /* SKGyroscope.m in Sources */,
-				CFBB416819B928C2002AE1A9 /* SKBeacon.m in Sources */,
+				CFBB416819B928C2002AE1A9 /* SKiBeaconProximity.m in Sources */,
 				CF8E9BD01B3200E7005AC2FC /* SKBeaconData.m in Sources */,
 				CFB0D94C1B52690500A7982B /* SKMagnetometerData.m in Sources */,
 				CFB0D94F1B52698C00A7982B /* SKDeviceMotionData.m in Sources */,
@@ -586,6 +586,10 @@
 			buildSettings = {
 				DEAD_CODE_STRIPPING = NO;
 				DSTROOT = /tmp/SensingKit.dst;
+				FRAMEWORK_SEARCH_PATHS = (
+					"$(inherited)",
+					"$(PROJECT_DIR)",
+				);
 				GCC_PRECOMPILE_PREFIX_HEADER = YES;
 				GCC_PREFIX_HEADER = "SensingKit/SensingKit-Prefix.pch";
 				OTHER_LDFLAGS = "-ObjC";
@@ -602,6 +606,10 @@
 				COPY_PHASE_STRIP = NO;
 				DEAD_CODE_STRIPPING = NO;
 				DSTROOT = /tmp/SensingKit.dst;
+				FRAMEWORK_SEARCH_PATHS = (
+					"$(inherited)",
+					"$(PROJECT_DIR)",
+				);
 				GCC_PRECOMPILE_PREFIX_HEADER = YES;
 				GCC_PREFIX_HEADER = "SensingKit/SensingKit-Prefix.pch";
 				OTHER_LDFLAGS = "-ObjC";
diff --git a/SensingKit/SKBeaconData.h b/SensingKit/SKBeaconData.h
@@ -28,15 +28,17 @@
 
 @interface SKBeaconData : SKSensorData
 
-@property (nonatomic, strong, readonly) NSString *identifier;
+@property (nonatomic, readonly) NSUInteger major;
+@property (nonatomic, readonly) NSUInteger minor;
 @property (nonatomic, readonly) CLLocationAccuracy accuracy;
 @property (nonatomic, readonly) CLProximity proximity;
 @property (nonatomic, readonly) NSInteger rssi;
 
-- (instancetype)initWithIdentifier:(NSString *)identifier
-                      withAccuracy:(CLLocationAccuracy)accuracy
-                     withProximity:(CLProximity)proximity
-                          withRssi:(NSInteger)rssi;
+- (instancetype)initWithMajor:(NSUInteger)major
+                    withMinor:(NSUInteger)minor
+                 withAccuracy:(CLLocationAccuracy)accuracy
+                withProximity:(CLProximity)proximity
+                     withRssi:(NSInteger)rssi;
 
 - (NSString *)proximityString;
 
diff --git a/SensingKit/SKBeaconData.m b/SensingKit/SKBeaconData.m
@@ -26,14 +26,16 @@
 
 @implementation SKBeaconData
 
-- (instancetype)initWithIdentifier:(NSString *)identifier
-                      withAccuracy:(CLLocationAccuracy)accuracy
-                     withProximity:(CLProximity)proximity
-                          withRssi:(NSInteger)rssi
+- (instancetype)initWithMajor:(NSUInteger)major
+                    withMinor:(NSUInteger)minor
+                 withAccuracy:(CLLocationAccuracy)accuracy
+                withProximity:(CLProximity)proximity
+                     withRssi:(NSInteger)rssi
 {
     if (self = [super init])
     {
-        _identifier = identifier;
+        _major = major;
+        _minor = minor;
         _accuracy = accuracy;
         _proximity = proximity;
         _rssi = rssi;
@@ -64,9 +66,10 @@ - (NSString *)proximityString
 
 - (NSString *)csvString
 {
-    return [NSString stringWithFormat:@"%f,%@,%f,%@,%ld",
+    return [NSString stringWithFormat:@"%f,%lu,%lu,%f,%@,%ld",
             [self timestampEpoch],
-            _identifier,
+            (unsigned long)_major,
+            (unsigned long)_minor,
             _accuracy,
             [self proximityString],
             (long)_rssi];
diff --git a/SensingKit/SKSensorModuleManager.m b/SensingKit/SKSensorModuleManager.m
@@ -28,7 +28,7 @@
 // SensorModules
 #import "SKBattery.h"
 #import "SKLocation.h"
-#import "SKBeacon.h"
+#import "SKiBeaconProximity.h"
 #import "SKAccelerometer.h"
 #import "SKGyroscope.h"
 #import "SKMagnetometer.h"
@@ -209,9 +209,10 @@ - (SKAbstractSensorModule *)createSensorModule:(SKSensorModuleType)moduleType
             sensorModule = [[SKLocation alloc] init];
             break;
             
-        case Beacon:
-            sensorModule = [[SKBeacon alloc] initWithUUID:[[NSUUID alloc] initWithUUIDString:@"d45a1046-15b0-11e5-b60b-1697f925ec7b"]
-                                             withDeviceId:arc4random_uniform(65535)];  // Random id
+        case iBeaconProximity:
+            sensorModule = [[SKiBeaconProximity alloc] initWithUUID:[[NSUUID alloc] initWithUUIDString:@"d45a1046-15b0-11e5-b60b-1697f925ec7b"]
+                                                          withMajor:arc4random_uniform(65535)    // Random Major
+                                                          withMinor:arc4random_uniform(65535)];  // Random Minor
             break;
             
             // Don't forget to break!
@@ -249,8 +250,8 @@ - (NSString *)getSensorModuleInString:(SKSensorModuleType)moduleType
         case Location:
             return @"Location";
             
-        case Beacon:
-            return @"Beacon";
+        case iBeaconProximity:
+            return @"iBeaconProximity";
             
         default:
             return [NSString stringWithFormat:@"Unknown SensorModule: %li", (long)moduleType];
diff --git a/SensingKit/SKSensorModuleType.h b/SensingKit/SKSensorModuleType.h
@@ -30,5 +30,5 @@ typedef NS_ENUM(NSInteger, SKSensorModuleType) {
     Activity,
     Battery,
     Location,
-    Beacon
+    iBeaconProximity
 };
diff --git a/SensingKit/SKiBeaconProximity.h b/SensingKit/SKiBeaconProximity.h
@@ -1,5 +1,5 @@
 //
-//  SKBeacon.h
+//  SKiBeaconProximity.h
 //  SensingKit
 //
 //  Copyright (c) 2014. Queen Mary University of London
@@ -28,9 +28,10 @@
 @import CoreBluetooth;
 @import CoreLocation;
 
-@interface SKBeacon : SKAbstractSensorModule<CBPeripheralManagerDelegate, CLLocationManagerDelegate>
+@interface SKiBeaconProximity : SKAbstractSensorModule<CBPeripheralManagerDelegate, CLLocationManagerDelegate>
 
 - (instancetype)initWithUUID:(NSUUID *)UUID
-                withDeviceId:(NSUInteger)device_id;
+                   withMajor:(NSUInteger)major
+                   withMinor:(NSUInteger)minor;
 
 @end
diff --git a/SensingKit/SKiBeaconProximity.m b/SensingKit/SKiBeaconProximity.m
@@ -1,5 +1,5 @@
 //
-//  SKBeacon.m
+//  SKiBeaconProximity.m
 //  SensingKit
 //
 //  Copyright (c) 2014. Queen Mary University of London
@@ -22,10 +22,10 @@
 //  along with SensingKit-iOS.  If not, see <http://www.gnu.org/licenses/>.
 //
 
-#import "SKBeacon.h"
+#import "SKiBeaconProximity.h"
 #import "SKBeaconData.h"
 
-@interface SKBeacon()
+@interface SKiBeaconProximity()
 
 @property (strong, nonatomic) CLBeaconRegion      *broadcast_beaconRegion;
 @property (strong, nonatomic) CLBeaconRegion      *scan_beaconRegion;
@@ -34,27 +34,32 @@ @interface SKBeacon()
 
 @end
 
-@implementation SKBeacon
+@implementation SKiBeaconProximity
 
 - (instancetype)initWithUUID:(NSUUID *)UUID
-                withDeviceId:(NSUInteger)device_id
+                   withMajor:(NSUInteger)major
+                   withMinor:(NSUInteger)minor
 {
     if (self = [super init])
     {
         // init iBeacon managers
-        [self initBeaconSensingWithUUID:UUID withDeviceId:device_id];
+        [self initBeaconSensingWithUUID:UUID
+                              withMajor:major
+                              withMinor:minor];
     }
     return self;
 }
 
 - (void)initBeaconSensingWithUUID:(NSUUID *)UUID
-                     withDeviceId:(NSUInteger)device_id
+                        withMajor:(NSUInteger)major
+                        withMinor:(NSUInteger)minor
 {
     // Get a unique identifier for the device
     NSString *identifier = [[[UIDevice currentDevice] identifierForVendor] UUIDString];
     
     self.broadcast_beaconRegion = [[CLBeaconRegion alloc] initWithProximityUUID:UUID
-                                                                          major:device_id
+                                                                          major:major
+                                                                          minor:minor
                                                                      identifier:identifier];
     
     self.scan_beaconRegion = [[CLBeaconRegion alloc] initWithProximityUUID:UUID
@@ -146,10 +151,11 @@ - (void)locationManager:(CLLocationManager *)manager didRangeBeacons:(NSArray *)
     {
         if (beacon)
         {
-            SKBeaconData *data = [[SKBeaconData alloc] initWithIdentifier:beacon.major.stringValue
-                                                             withAccuracy:beacon.accuracy
-                                                            withProximity:beacon.proximity
-                                                                 withRssi:beacon.rssi];
+            SKBeaconData *data = [[SKBeaconData alloc] initWithMajor:beacon.major.unsignedIntegerValue
+                                                           withMinor:beacon.minor.unsignedIntegerValue
+                                                        withAccuracy:beacon.accuracy
+                                                       withProximity:beacon.proximity
+                                                            withRssi:beacon.rssi];
             
             [self submitSensorData:data];
         }
diff --git a/SensingKitTests/SensingKitTests.m b/SensingKitTests/SensingKitTests.m
@@ -88,7 +88,7 @@ - (void)testSensorRegistrationDeregistration
     [self.sensingKit registerSensorModule:Activity];
     [self.sensingKit registerSensorModule:Battery];
     [self.sensingKit registerSensorModule:Location];
-    [self.sensingKit registerSensorModule:Beacon];
+    [self.sensingKit registerSensorModule:iBeaconProximity];
     
     // test deregistration
     [self.sensingKit deregisterSensorModule:Accelerometer];
@@ -98,7 +98,7 @@ - (void)testSensorRegistrationDeregistration
     [self.sensingKit deregisterSensorModule:Activity];
     [self.sensingKit deregisterSensorModule:Battery];
     [self.sensingKit deregisterSensorModule:Location];
-    [self.sensingKit deregisterSensorModule:Beacon];
+    [self.sensingKit deregisterSensorModule:iBeaconProximity];
 }
 
 @end
