Aeris iOS Weather SDK

The Aeris iOS Framework allows a developer to quickly and easily add weather content and functionality to their iOS applications quickly and easily without having to code anything themselves. It utilizes the Aeris API backend for data loading and is built on top of an object mapping system that efficiently loads requested weather content into third-party iOS applications, greatly reducing the amount of code and development needed on the developer end.

 
 
 
 
 
 
 
 
 
 
 
 
 
 

Requirements

Migrating from 1.0 to 2.0

If you’re upgrading from a pre-2.0 version of the SDK, review the 2.0 Migration Guide for an overview of the architectural changes from 1.0.

Installing

Before you can begin using the Aeris iOS SDK in your project, you will need to download the latest version of the SDK and ensure that you have the required Aeris API keys for your application.

Step 1: Download the latest version of the Aeris iOS SDK.

Step 2: Obtain Aeris API access keys by registering your application with your account.

Step 3: Determine which components of the Aeris iOS SDK you will need for your project:

  • Aeris.framework
  • AerisUI.framework

    • requires: Aeris.framework
  • AerisMap.framework

    • requires: Aeris.framework, AerisUI.framework
  • AerisGoogleMap.framework

Step 4: Import AFNetworking 2.0 into your project either manually or using CocoaPods by following AFNetworking's installation instructions. AFNetworking is a required dependency for the Aeris iOS SDK and must be version 2.0 or higher.

Step 5: Install the Aeris iOS SDK files into your project. The following step-by-step instructions are written for Xcode 5 and higher using the iOS 7+ SDK:

  1. Launch Xcode and either open an existing project or create a new project.
  2. Drag the Aeris iOS component framework bundles you need from the list in Step 3 to the Frameworks group of your project. When prompted, select Copy items into destination group’s folder.
  3. Select your project from the Project Navigator and choose your application’s target.
  4. Open the Build Phases tab, and within Link Binary with Libraries, add the following frameworks. If you install AFNetworking in step 4 using Cocoapods, then many of these libraries and more will already be linked with your project:
    • CoreGraphics.framework
    • CoreLocation.framework
    • Foundation.framework
    • MapKit.framework (required by AerisMap.framework)
    • QuartzCore.framework (required by AerisUI.framework)
    • UIKit.framework (required by AerisUI.framework)
  5. Choose your project (not a specific target) and open the Build Settings tab.
  6. In the Other Linker Flags section, add -ObjC. If these settings are not visible, change the filter in the Build Settings bar from Basic to All.
  7. Import your required Aeris iOS SDK framework bundles into the necessary portions of your project, or within your project’s global precompiled header (*.pch) file:
    #import <Aeris/Aeris.h>
    #import <AerisUI/AerisUI.h>
    #import <AerisMap/AerisMap.h>
    
  8. Initialize AerisEngine with your application’s API access keys in your AppDelegate:
    - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
    	self.window = [[UIWindow alloc] initWithFrame:[UIScreen mainScreen].bounds];
    
    	[AerisEngine engineWithKey:@"__CLIENT_ID__" secret:@"__CLIENT_SECRET__"];
    
    	self.window.backgroundColor = [UIColor whiteColor];
    	[self.window makeKeyAndVisible];
    
    	return YES;
    }
    
  9. That’s it, your project is ready to start using the Aeris iOS SDK!

Upgrading

To upgrade an existing project to the most recent version of the SDK:

  1. In the Project Navigator, replace the previous Aeris framework bundles with the most recent versions.
  2. Make any necessary changes as a result of the upgrade as described in the release notes.
  3. Clean and rebuild your project by selecting: Product > Clean and then Product > Build or Product > Run.

Debugging

Occasionally it may be useful to have the Aeris iOS SDK output additional log messages in order to debug issues within your own application, such as API requests and errors as well as internal view and map events. By default, the Aeris iOS SDK only outputs error messages and warnings. So if you require more information during development and testing, just enable debug mode after initializing the AerisEngine with your access keys:


[AerisEngine engineWithKey:@"__CLIENT_ID__" secret:@"__CLIENT_SECRET__"];
[AerisEngine enableDebug];