Skip to content
This repository has been archived by the owner on Aug 11, 2021. It is now read-only.

Commit

Permalink
Release v1.1
Browse files Browse the repository at this point in the history
  • Loading branch information
jhvdb87 committed Jul 18, 2013
1 parent 4eb91f4 commit c77fce5
Show file tree
Hide file tree
Showing 130 changed files with 21,229 additions and 2,829 deletions.
Binary file modified Documentation/APIReference.zip
Binary file not shown.
@@ -1,9 +1,7 @@
//
// SDK.h
// HueSDK v1.0 beta
//
// Copyright (c) 2012-2013 Philips. All rights reserved.
//
/*******************************************************************************
Copyright (c) 2013 Koninklijke Philips N.V.
All Rights Reserved.
********************************************************************************/

#import "PHBridgeResourcesCache.h"
#import "PHBridgeResourcesReader.h"
Expand All @@ -15,6 +13,7 @@
#import "PHLight.h"
#import "PHLightState.h"
#import "PHSchedule.h"
#import "PHScene.h"
#import "PHSoftwareUpdateStatus.h"
#import "PHNotificationManager.h"
#import "PHHueSDK.h"
Expand Down
21 changes: 12 additions & 9 deletions HueSDK.framework/Versions/A/Headers/PHBridgeConfiguration.h
@@ -1,17 +1,15 @@
//
// PHBridgeConfiguration.h
// HueSDK v1.0 beta
//
// Copyright (c) 2012-2013 Philips. All rights reserved.
//
/*******************************************************************************
Copyright (c) 2013 Koninklijke Philips N.V.
All Rights Reserved.
********************************************************************************/

#import <Foundation/Foundation.h>

@class PHBridgeResource;
@class PHSoftwareUpdateStatus;

/**
Contains the configuration data of the bridge
Contains the configuration data of the bridge
*/
@interface PHBridgeConfiguration : NSObject
/**
Expand Down Expand Up @@ -90,10 +88,15 @@
@property (nonatomic, strong) NSString *time;

/**
Converts the bridge time string to an NSDate
@returns The date/time setting of the bridge converted to an NSDate
Converts the bridge time string to an NSDate
@returns The date/time setting of the bridge converted to an NSDate
*/
- (NSDate *)getBridgeTimeAsNSDate;

/**
Converts the bridge configuration to a NSDictionary
@returns The configuration of the bridge to a NSDictionary
*/
- (NSDictionary *)bridgeConfigurationAsDictionary;

@end
10 changes: 4 additions & 6 deletions HueSDK.framework/Versions/A/Headers/PHBridgeResource.h
@@ -1,9 +1,7 @@
//
// PHBridgeResource.h
// HueSDK v1.0 beta
//
// Copyright (c) 2012-2013 Philips. All rights reserved.
//
/*******************************************************************************
Copyright (c) 2013 Koninklijke Philips N.V.
All Rights Reserved.
********************************************************************************/

#import <Foundation/Foundation.h>

Expand Down
10 changes: 4 additions & 6 deletions HueSDK.framework/Versions/A/Headers/PHBridgeResourcesCache.h
@@ -1,9 +1,7 @@
//
// PHBridgeResourcesCache.h
// HueSDK v1.0 beta
//
// Copyright (c) 2012-2013 Philips. All rights reserved.
//
/*******************************************************************************
Copyright (c) 2013 Koninklijke Philips N.V.
All Rights Reserved.
********************************************************************************/

#import <Foundation/Foundation.h>

Expand Down
10 changes: 4 additions & 6 deletions HueSDK.framework/Versions/A/Headers/PHBridgeResourcesReader.h
@@ -1,9 +1,7 @@
//
// PHBridgeResourcesReader.h
// HueSDK v1.0 beta
//
// Copyright (c) 2012-2013 Philips. All rights reserved.
//
/*******************************************************************************
Copyright (c) 2013 Koninklijke Philips N.V.
All Rights Reserved.
********************************************************************************/

#import <Foundation/Foundation.h>

Expand Down
10 changes: 4 additions & 6 deletions HueSDK.framework/Versions/A/Headers/PHBridgeSearching.h
@@ -1,9 +1,7 @@
//
// PHBridgeSearching.h
// HueSDK v1.0 beta
//
// Copyright (c) 2012-2013 Philips. All rights reserved.
//
/*******************************************************************************
Copyright (c) 2013 Koninklijke Philips N.V.
All Rights Reserved.
********************************************************************************/

#import <Foundation/Foundation.h>

Expand Down
71 changes: 55 additions & 16 deletions HueSDK.framework/Versions/A/Headers/PHBridgeSendAPI.h
@@ -1,9 +1,7 @@
//
// PHBridgeSendAPI.h
// HueSDK v1.0 beta
//
// Copyright (c) 2012-2013 Philips. All rights reserved.
//
/*******************************************************************************
Copyright (c) 2013 Koninklijke Philips N.V.
All Rights Reserved.
********************************************************************************/

#import <Foundation/Foundation.h>

Expand All @@ -14,6 +12,7 @@
@class PHGroup;
@class PHSchedule;
@class PHSoftwareUpdateStatus;
@class PHScene;

/**
This is a typedef for a block type. It takes an array of PHErrors.
Expand All @@ -25,6 +24,11 @@ typedef void (^PHBridgeSendErrorArrayCompletionHandler)(NSArray *errors);
*/
typedef void (^PHBridgeSendDictionaryCompletionHandler)(NSDictionary *dictionary, NSArray *errors);

/**
This is a typedef for a block type. It takes an NSDictionary, a string (this can be "never", "active" or a string representation of the UTC date of the last search and an array of PHErrors.
*/
typedef void (^PHBridgeSendGetNewLightsCompletionHandler)(NSDictionary *dictionary, NSString *lastScan, NSArray *errors);

/*
This is a typedef for a block type. It takes an NSArray and an array of PHErrors.
*/
Expand Down Expand Up @@ -64,22 +68,29 @@ typedef void (^PHBridgeSendSoftwareUpdateStatusCompletionHandler)(PHSoftwareUpda
Starts a search for new lights
@param completionHandler completionHandler for error handling
*/
-(void)searchForNewLights:(PHBridgeSendErrorArrayCompletionHandler)completionHandler;;
- (void)searchForNewLights:(PHBridgeSendErrorArrayCompletionHandler)completionHandler;

/**
Starts a search for new lights using the given serials.
@param serials An array of serials (NSStrings of hex characters), maximum of 10
@param completionHandler completionHandler for error handling
*/
- (void)searchForNewLightsWithSerials:(NSArray *)serials completionHandler:(PHBridgeSendErrorArrayCompletionHandler)completionHandler;

/**
Updates the light properties
@param light the details of the light to be updated
@param completionHandler completionHandler for error handling
*/
-(void)updateLightWithLight:(PHLight *)light completionHandler:(PHBridgeSendErrorArrayCompletionHandler)completionHandler;
- (void)updateLightWithLight:(PHLight *)light completionHandler:(PHBridgeSendErrorArrayCompletionHandler)completionHandler;

/**
Updates the state settings of the light
@param lightIdentifier the identifier of the light to be updated
@param lightState the lightstate settings for to set the light to
@param completionHandler completionHandler for error handling
*/
-(void)updateLightStateForId:(NSString *)lightIdentifier withLighState:(PHLightState *)lightState completionHandler:(PHBridgeSendErrorArrayCompletionHandler)completionHandler;
- (void)updateLightStateForId:(NSString *)lightIdentifier withLighState:(PHLightState *)lightState completionHandler:(PHBridgeSendErrorArrayCompletionHandler)completionHandler;

/**
Updates the bridge configuration
Expand All @@ -99,30 +110,30 @@ typedef void (^PHBridgeSendSoftwareUpdateStatusCompletionHandler)(PHSoftwareUpda
Get newly found lights since last search for new lights
@param completionHandler completionHandler for returning this lights found and error handling
*/
-(void)getNewFoundLights:(PHBridgeSendDictionaryCompletionHandler)completionHandler;
- (void)getNewFoundLights:(PHBridgeSendGetNewLightsCompletionHandler)completionHandler;

/**
Creates a new Group of lights
@param name the name of the group
@param lightIds the array of light ids to group
@param completionHandler completionHandler for details of created group or error handling
*/
-(void)createGroupWithName:(NSString *)name lightIds:(NSArray *)lightIds completionHandler:(PHBridgeSendGroupCompletionHandler)completionHandler
- (void)createGroupWithName:(NSString *)name lightIds:(NSArray *)lightIds completionHandler:(PHBridgeSendGroupCompletionHandler)completionHandler
;

/**
Update a given Group of lights
@param group the details of the group to update
@param completionHandler completionHandler for error handling
*/
-(void)updateGroupWithGroup:(PHGroup *)group completionHandler:(PHBridgeSendErrorArrayCompletionHandler)completionHandler;
- (void)updateGroupWithGroup:(PHGroup *)group completionHandler:(PHBridgeSendErrorArrayCompletionHandler)completionHandler;

/**
Remote the group with the given identifier
@param groupIdentifier the identifier of the group to remove
@param completionHandler completionHandler for error handling
*/
-(void)removeGroupWithId:(NSString *)groupIdentifier completionHandler:(PHBridgeSendErrorArrayCompletionHandler)completionHandler;
- (void)removeGroupWithId:(NSString *)groupIdentifier completionHandler:(PHBridgeSendErrorArrayCompletionHandler)completionHandler;

/**
Performs the action for the specified group
Expand All @@ -137,21 +148,21 @@ typedef void (^PHBridgeSendSoftwareUpdateStatusCompletionHandler)(PHSoftwareUpda
@param schedule the details of the schedule
@param completionHandler completionHandler for details of schedule created or error handling
*/
-(void)createSchedule:(PHSchedule *)schedule completionHandler:(PHBridgeSendScheduleCompletionHandler)completionHandler;
- (void)createSchedule:(PHSchedule *)schedule completionHandler:(PHBridgeSendScheduleCompletionHandler)completionHandler;

/**
Remove the schedule with the given identifier
@param scheduleIdentifier the identifier of the schedule to remove
@param completionHandler completionHandler for error handling
*/
-(void)removeScheduleWithId:(NSString *)scheduleIdentifier completionHandler:(PHBridgeSendErrorArrayCompletionHandler)completionHandler;
- (void)removeScheduleWithId:(NSString *)scheduleIdentifier completionHandler:(PHBridgeSendErrorArrayCompletionHandler)completionHandler;

/**
Updates the schedule information
@param schedule the schedule to be updated
@param completionHandler completionHandler for error handling
*/
-(void)updateScheduleWithSchedule:(PHSchedule *)schedule completionHandler:(PHBridgeSendErrorArrayCompletionHandler)completionHandler;
- (void)updateScheduleWithSchedule:(PHSchedule *)schedule completionHandler:(PHBridgeSendErrorArrayCompletionHandler)completionHandler;

#pragma mark - Software update

Expand Down Expand Up @@ -180,4 +191,32 @@ typedef void (^PHBridgeSendSoftwareUpdateStatusCompletionHandler)(PHSoftwareUpda
*/
- (void)setCacheUpdateAfterSuccessResponseEnabled:(BOOL)enabled;

#pragma mark - Scenes

/**
Gets all scenes from the bridge.
@param completionHandler completionHandler for returning the current status and error handling
*/
- (void)getAllScenesWithCompletionHandler:(PHBridgeSendDictionaryCompletionHandler)completionHandler;

/**
@see PHBridgeSendAPI#saveSceneWithCurrentLightStates
*/
- (void)saveScene:(PHScene *)scene completionHandler:(PHBridgeSendErrorArrayCompletionHandler)completionHandler __attribute__((deprecated));

/**
Save the scene information to the bridge
@param scene PHScene object that should be saved
@param completionHandler completionHandler for returning the current status and error handling
*/
- (void)saveSceneWithCurrentLightStates:(PHScene *)scene completionHandler:(PHBridgeSendErrorArrayCompletionHandler)completionHandler;

/**
Activate scene
@param sceneIdentifier the identifier of the sceme to activate
@param groupIdentifier the identifier of the group that should apply the scene
@param completionHandler completionHandler for returning the current status and error handling
*/
- (void)activateSceneWithIdentifier:(NSString *)sceneIdentifier onGroup:(NSString *)groupIdentifier completionHandler:(PHBridgeSendErrorArrayCompletionHandler)completionHandler;

@end
17 changes: 11 additions & 6 deletions HueSDK.framework/Versions/A/Headers/PHError.h
@@ -1,9 +1,7 @@
//
// PHError.h
// HueSDK v1.0 beta
//
// Copyright (c) 2012-2013 Philips. All rights reserved.
//
/*******************************************************************************
Copyright (c) 2013 Koninklijke Philips N.V.
All Rights Reserved.
********************************************************************************/

#import <Foundation/Foundation.h>

Expand Down Expand Up @@ -31,6 +29,13 @@ typedef enum {
PUSHLINK_NO_CONNECTION = 60,
PUSHLINK_TIME_LIMIT_REACHED = 61,
PUSHLINK_NO_LOCAL_BRIDGE = 62,

// Unsupported
UNSUPPORTED_IN_THIS_VERSION = 80,


// Domain objects
INVALID_OBJECT_PARAMETER = 80,

CLIP_ERROR = 100
} CLErrorCode;
Expand Down
10 changes: 4 additions & 6 deletions HueSDK.framework/Versions/A/Headers/PHGroup.h
@@ -1,9 +1,7 @@
//
// PHGroup.h
// HueSDK v1.0 beta
//
// Copyright (c) 2012-2013 Philips. All rights reserved.
//
/*******************************************************************************
Copyright (c) 2013 Koninklijke Philips N.V.
All Rights Reserved.
********************************************************************************/

#import <Foundation/Foundation.h>
#import "PHBridgeResource.h"
Expand Down
16 changes: 10 additions & 6 deletions HueSDK.framework/Versions/A/Headers/PHHueSDK.h
@@ -1,9 +1,7 @@
//
// PHHueSDK.h
// HueSDK v1.0 beta
//
// Copyright (c) 2012-2013 Philips. All rights reserved.
//
/*******************************************************************************
Copyright (c) 2013 Koninklijke Philips N.V.
All Rights Reserved.
********************************************************************************/

#import <Foundation/Foundation.h>

Expand Down Expand Up @@ -93,4 +91,10 @@
*/
- (void)disableCacheUpdateLocalHeartbeat:(BOOL)disableCacheUpdate;

/**
Enables the logging
@param enableLogging When YES, the logging is enabled, otherwise disabled.
*/
- (void)enableLogging:(BOOL)enableLogging;

@end
10 changes: 4 additions & 6 deletions HueSDK.framework/Versions/A/Headers/PHLight.h
@@ -1,9 +1,7 @@
//
// PHLight.h
// HueSDK v1.0 beta
//
// Copyright (c) 2012-2013 Philips. All rights reserved.
//
/*******************************************************************************
Copyright (c) 2013 Koninklijke Philips N.V.
All Rights Reserved.
********************************************************************************/

#import <Foundation/Foundation.h>
#import "PHBridgeResource.h"
Expand Down

0 comments on commit c77fce5

Please sign in to comment.