Phunware Mapping SDK for iOS
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
Docs
Framework/PWMapKit.framework
Samples
.gitignore
CHANGELOG.md
MIGRATION.md
PWMapKit.podspec
README.md

README.md

PWMapKit SDK for iOS

Version 3.5.2

PWMapKit is a comprehensive indoor mapping and wayfinding SDK that allows easy integration with Phunware's indoor maps and location-based services. Visit http://maas.phunware.com/ for more details and to sign up.

Requirements

  • PWLocation 3.5.1 and above (Automatically included when pod install PWMapKit)
  • PWCore 3.7.x (Automatically included when pod install PWMapKit)
  • iOS 10.0 or greater
  • Xcode 8 or greater

Installation

  • Phunware recommends using CocoaPods to integrate the framework. Simply add

    pod 'PWMapKit'

    to your podfile, then the dependencies of PWCore and PWLocation are automatically added.

Documentation

Framework documentation is included in the the repository's Documents folder in both HTML and Docset formats. You can also find the latest documentation online.

Usage

The primary use of the components of PWMapKit revolve around creating a map view, displaying points of interest, showing the user's location and indoor routing.

Setup

Make sure your app is correctly set up before you start working on map integration.

Location Permissions

Location authorization of "When In Use" or "Always" is required for a PWLocationManager to function normally. Please follow Apple's Best Practices for requesting location permissions. Do not attempt to use a PWLocationManager if the user does not provide location authorization as this can lead to unexpected behavior.

Adding Map View

// Load a building.
[PWBuilding buildingWithIdentifier:<#buildingID#> completion:^(PWBuilding *building, NSError *error) {
	// Get the buliding object here
	<#building#>					
}];

...

// Show the building on the map
PWMapView *map = [[PWMapView alloc] initWithFrame:<#frame#>];
map.delegate = self;
[self.view addSubview:map];

[mapView setBuilding:<#building#> animated:<#animated#> onCompletion:(void (^)(NSError *error))completion]

Register Location Provider

The PWMapView can display a user location on the map if a location provider is registered with the PWMapView. The location providers are in the PWLocation framework, and each different provider requires different steps to set up (see readme here https://github.com/phunware/maas-location-ios-sdk to view setup examples of all different provider options). Once the location provider is initialized, the following call may be used to register the provider with the PWMapView:

[mapView registerLocationManager:<managerObject>];

NOTE: If using a virtual beacon provider such as Mist or Beacon Point, the "Uses Bluetooth LE accessories" background mode must be enabled in the "Capabilities" tab of your project's settings.

Routing

[PWRoute initRouteFrom:<#startPoint#> to:<#endPoint#> accessibility:<#accessibility#> excludedPoints:<#excludedPoints#> completion:^(PWRoute *route, NSError *error) {
	// Plot the route on the map
	[mapView navigateWithRoute:route];            
}];

Attribution

PWMapKit uses the following third-party components. All components are prefixed with PW to avoid namespace collisions should your application also use an included component.

Component Description License
SVPulsingAnnotationView A customizable MKUserLocationView replica for your iOS app. MIT

Privacy

You understand and consent to Phunware’s Privacy Policy located at www.phunware.com/privacy. If your use of Phunware’s software requires a Privacy Policy of your own, you also agree to include the terms of Phunware’s Privacy Policy in your Privacy Policy to your end users.

Terms

Use of this software requires review and acceptance of our terms and conditions for developer use located at http://www.phunware.com/terms/