Getting Started
The Xweather Android SDK is divided into two primary components. Depending on your project's needs, you may only need to use one or both of the weather SDK's components. If you are using the mapping library, the Core library is already included.
Each of the components are outlined below:
- AerisWeather Core library
- AerisWeather Maps library (includes the Core library)
AerisWeather Core
The AerisWeather Core library provides the standard functionality required for interacting with the Xweather Weather API (opens in a new tab). This library provides access to textual products from the weather API, not graphics or imagery. Review the complete Weather API documentation (opens in a new tab) for more details regarding the various objects and methods available to your project within the AerisWeather Core library and Xweather Weather API.
AerisWeather Maps
The Xweather Raster Maps library provides everything needed to add a fully interactive weather map to your Android project. As of version 2 of the SDK, this also includes the wide array of map layers provided by Xweather Raster Maps (opens in a new tab) (additional subscription needed). In addition to the wide variety of tile weather data layers (opens in a new tab) such as radar, satellite, etc. provided by Xweather Raster Maps, there are also point and polygon layers available to further enhance your maps. Review the complete Weather API documentation (opens in a new tab) for more details regarding the public objects and methods available to your project within the AerisWeather Maps library.
Start using the Xweather Android SDK
You'll need an active Xweather Weather API subscription (opens in a new tab) and your application registered with in order to receive the required access ID and secret key.
Create an AerisWeather account
Sign up for an Xweather Flex subscription (opens in a new tab). We offer a free developer account (opens in a new tab) for you to give our weather API a test drive.
Create your API access keys
Log in (opens in a new tab) to your account and find the Apps section to register your application for an API access key. Within the Apps section, click on New Application to register a new app. You will then be prompted to enter a project name and namespace. These can be updated at any time.
Follow our SDK installation and setup guides
Set up your Android application by following the installation guide to integrate the SDK into your project.
Review our SDK usage documentation
Review our usage documentation for loading data or creating a weather map.
Reference the SDK developer documentation
Reference the SDK API documentation for information regarding the classes, methods and properties used throughout the SDK.
Demo App
The SDK also includes a demo app, providing code examples of many common Core and Map library usages. For more details regarding the setup and use of the demo, review additional information about the demo app.