Skip to end of metadata
Go to start of metadata

This documentation is no longer actively supported and may be out of date. Going forward, please visit and bookmark our new site (https://docs.phunware.com/) for up-to-date documentation.

Have feedback?  Please send us your feedback in our feedback portal!

Phunware's Location Based Services (LBS) module powers robust Mapping, Navigation and Wayfinding experiences to guide your app users around physical venues via turn-by-turn directions. Blue Dot Indoor Navigation can be optionally added to allow users to see their position and movements on a map in real time, mirroring Apple/Google Maps blue dot experiences.

Note: Blue Dot Indoor Navigation requires location hardware installation and configuration.

The Location Based Services (LBS) module includes:

  • Mapping and Location SDKs and APIs (for iOS/Android apps)
  • MaaS portal web management tool, to manage venue/building/floor information, maps, points of interest (POIs) and routes

 

 

This documentation is no longer actively supported and may be out of date. Going forward, please visit and bookmark our new site (https://docs.phunware.com/) for up-to-date documentation.

Location Based Services Releases

DateUpdates/Release NotesiOS Mapping SDKiOS Location SDKAndroid Mapping SDKAndroid Location SDKNotes
09.12.17Location SharingMapping v3.1.4 Mapping v3.1.2  
09.12.17Custom POIsMapping v3.1.2 Mapping v3.1.2  
03.29.17Mist(vBLE) Location Provider    
  • Support new location providers
    • Mist (vBLE)
    • BeaconPoint
02.02.17Managed ProviderMapping v3.1.0Location v3.1.0Mapping v3.1.0Location v3.1.0
  • Updates SDK support
       
Use of this software requires review and acceptance of our terms and conditions for developer use located at http://www.phunware.com/terms/

This documentation is no longer actively supported and may be out of date. Going forward, please visit and bookmark our new site (https://docs.phunware.com/) for up-to-date documentation.

Location Based Services Training Resources

Document Title/LinkDocument DescriptionLast Updated
Mapping (LBS) Module #1: Venue-Campus-Building-Floor Hierarchy Configuration This training video shows you how to construct a map hierarchy in Phunware's MaaS portal and load the maps you will configure for your mobile applications.7/5/2017
Mapping (LBS) Module #1.5: Map Alignment This training video shows you how to use the Set Map tools in Phunware's MaaS portal to align your uploaded floor maps with an accurate world grid so it is set at an accurate latitude and longitude.7/5/2017
Mapping (LBS) Module #2: POI In-app Display

This video gives you preview of how your maps and POIs appear in your Mobile applications after you have completed the configuration in MaaS Portal

7/5/2017
Mapping (LBS) Module #3: POI Configuration This training video shows you how to set and configure points of interest (POIs) on your floor maps in Phunware's MaaS portal.7/5/2017
Mapping (LBS) Module #4: Custom POI Icon and Banner ConfigurationThis training video shows you how to configure optional advanced options for your POIs including: custom POI icons and metadata (like POI card banners) to your POI's.7/5/2017
Mapping (LBS) Module #5: Route ConfigurationThis training video shows you how to configure wayfinding routes in Phunware's MassS Portal using waypoints, routes and inaccessible waypoints and routes to assist with both static and dynamic wayfinding in you applications.7/5/2017
 Mapping (LBS) Module #6: Publishing and Updating MapsThis training video shows you how to use the features of the Publishing tab in MaaS portal to view current and historical configuration changes and publish changes to your maps in your applications.7/5/2017
Mapping (LBS) Module #7: General Blue Dot Location Provider Configuration

This training video provides an introduction to configuring location providers for blue dot, turn-by-turn navigation in you applications. Each provided is configured differently so view the training specific to your implementation after viewing this video.

NOTE: This training video is specific to SDK v3.1.1 and newer

7/5/2017
Mapping (LBS) Module #7.1: Hyperlocation Configuration

This video provides configuration instructions specific to Location Provider - Cisco Hyperlocation

NOTE: This training video is specific to SDK v3.1.1 and newer

7/5/2017

Mapping (LBS) Module #7.2: BLE Configuration

This video provides configuration instructions specific to Location Provider - Cisco Beacon Point

NOTE: This training video is specific to SDK v3.1.1 and newer
7/5/2017
Mapping (LBS) Module #7.3: Beacon Point Configuration

This video provides configuration instructions specific to Location Provider - BLE

NOTE: This training video is specific to SDK v3.1.1 and newer
7/5/2017
Mapping (LBS) Module #7.4: Mist Configuration

This video provides configuration instructions specific to Location Provider - Mist

NOTE: This training video is specific to SDK v3.1.1 and newer
7/5/2017
Location-based Services End-to-End Training Presentation Power point training that explains the 2 types of Location-based Services Phunware offers, the SDKs used by them, the prerequisites for configuration and all the steps required to create, update, and delete Venues, Campuses, Buildings, Floors, Maps, POIs, Waypoints, Route Segments, and Location Providers for Blue dot navigation.3/6/2017
Use of this software requires review and acceptance of our terms and conditions for developer use located at http://www.phunware.com/terms/

This documentation is no longer actively supported and may be out of date. Going forward, please visit and bookmark our new site (https://docs.phunware.com/) for up-to-date documentation.

Location Based Services Configuration/Integration Guides

Document Title/LinkDocument DescriptionLast Updated
LBS (Mapping) Configuration Guide 1.0

This guide details how to use Phunware’s MaaS portal Mapping module to configure the two types of Location-based services you can enable: Mapping and Blue dot Turn-by-turn navigation.


3/23/2017
Map Creation Style Guide and Best Practices for MaaS Portal

This guide will explain how to create floor maps using a vector design tool like Adobe Illustrator and the graphic design conventions that will provide the best maps for wayfinding results in your Phunware-enabled mobile applications.


This guide provides best practices, instructions, and conventions for generating the SVG and PDF formatted maps as required for map configuration in MaaS portal.
3/31/2017
Dynamic Wayfinding Device Integration GuidesBecause Phunware provides hardware agnostic dynamic wayfinding experiences our customers have a variety of options as to the type of signal provider and the brand of hardware they choose to integrate. The following documents provide checklists and instructions for the integration of the types and brands of signal providers Phunware has worked with.1/23/2018
Beacon Validator App Users GuideThe guide will help with configuring the Beacon Validator Android app that is used validate and record the technical parameters of BLE beacons that will be fingerprinted for dynamic wayfinding application. The Beacon Validator App has been deprecated. Please do not use this app moving forward as it will not propagate beacon information to the new system. 
Phunware Locate App v2.1 Users Guide

The guide provides instructions, best practices, pre-requisites for using the Phunware Locate iOS App for fingerprinting a target venue.

Locate App enables BLE (Bluetooth Low Energy) driven blue dot by registering the signals from a venue’s beacons. This allows an app to determine its current position based on the strength of the various signals it hears, combined with the known locations (coordinates) of those signal sources.

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

This documentation is no longer actively supported and may be out of date. Going forward, please visit and bookmark our new site (https://docs.phunware.com/) for up-to-date documentation.


Android Location Based Services SDK Developer Documentation

Document Title/LinkSDK TypeDocument DescriptionLast Updated
Creating an ADA-Compliant app with Mapping SDK 3.0Mapping

Provides links and tips to creating Android mapping routing applications for the visually impaired.

10/10/2016
Android Mapping SDK - Getting Started (Android)Mapping

Provides a step-by-step quick start to adding a Phunware Map to an Android app.  Android Studio is the recommended development environment for building an app with the Phunware Mapping SDK.

1/30/2017

Integrating a Location Provider - Location SDK - Android (v3.0.0-3.1.0)

Location

This guide provides instructions for integrating Location SDK for routing. It is only applicable for users of the Android Location SDK v 3.0.0-3.1.0.

*If you are using a more recent version of the Android Location SDK, view the Location SDK-Managed Provider Integration Guide.

*If you are using an earlier version of the Location SDK for Android contact Phunware Support (support@phunware.com). 

1/30/2017
Android Mapping and Location SDK - Getting Started and Integration Guide (3.1.1 and newer)Mapping and Location

This guide provides instructions for getting started with the Location SDK and integrating Location SDK for routing. It is only applicable for users of the Android Location SDK v 3.1.1 and newer.

*If you are using version 3.0.0 - 3.1.0 of the Android Location SDK, view Integrating a Location Provider

*If you are using a version of the Location SDK for Android earlier than 3.0.0 contact Phunware Support for SDK assistance (support@phunware.com). 

3/10/2017

Mapping SDK - Using a MapView in a Custom Layout

Mapping

Provides examples and practice of MapView use, which is a subclass of the Google Maps MapView class and can be used to place a map in any Android View.

8/13/2016

Mapping SDK - Getting POI info from a Map Marker

Mapping

Explains how Mapping SDK associates a PointOptions object with its associated Google map marker object and provides and example of how to gain access the POI info from the marker by calling the getTag() method on the marker and casting it to PointOptions.

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

This documentation is no longer actively supported and may be out of date. Going forward, please visit and bookmark our new site (https://docs.phunware.com/) for up-to-date documentation.

iOS Location Based Services SDK Developer Documentation

Document Title/LinkSDK TypeDocument DescriptionLast Updated
Mapping SDK 3.0 (iOS)Mapping

Provides a link to all the documentation about the iOS Mapping classes used in the SDK

10/24/2016
Mapping SDK 3.0 Integration Guide (iOS)MappingProvides installation instructions, links to documentation, sample app information, usage and attribution for the iOS Mapping SDK10/24/2016

Routing for iOS Mapping

LocationProvides details around calculating and updating routes using the using PWMapKit and PWRoute respectively10/28/2016
Maps-ADA Sample App Developer Overview (iOS)Mapping

Provides a list of the controllers used for creating iOS mapping routing applications for the visually impaired.

10/28/2016
ADA-Specific UseLocation

Provides links and tips to creating Android mapping routing applications for the visually impaired.

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

This documentation is no longer actively supported and may be out of date. Going forward, please visit and bookmark our new site (https://docs.phunware.com/) for up-to-date documentation.

Location Based Services APIs

Document Title/LinkSDK/ API TypeDocument DescriptionLast Updated
Mapping API v1.1Mapping

This document describes the specification for the MaaS Mapping API ("API"), which allows remote clients to manage the various resources associated with mapping, including venues, campuses, buildings, floors, points of interest, segments and routes, including security and protocols.

1/15/2015
Mapping API ArchitectureMapping

Describes the Mapping API architecture including: Production URL, Request / Response Format, HTTP Method, Date / Time Format, Bracketed IDs ("[id]"s), Ellipses ("…"s), PUT Methods and Partial Updates, URL Definitions, and GET Methods and Query Strings

1/15/2015
Cisco Prime BindingLocation

Provides the POST steps and data to construct venues, campuses, buildings, floors and resources from data provided by Cisco Prime; includes the callback URL in Cisco Prime to which an HTTP POST request is sent.

1/15/2015
Mapping API MethodsMapping

Provides descriptions of the endpoints and methods for creating, updating, and deleting: VENUE, CAMPUS, BUILDING, FLOOR, RESOURCE, POINT, POI TYPE, ROUTE, SEGMENT; additional methods related to the main processes are also

1/15/2015
Mapping API Rich ExampleMappingThis document provides examples that showcase how developers can build an example venue. Upon completion, the venue will appear in the Multiscreen as a Service (MaaS) portal's Map Editor, where credentialed users can then create points of interest (POIs), segments and routes for the newly created venue's map.1/23/2015
Mapping API Response HandlingMappingProvides the HTTP status codes and and error payloads for the mapping API1/12/2015
POI TypesMappingA list of the pre-defined POI Types and their integer values in the database1/12/2015
Location API v1.2LocationThis document describes the specification for the MaaS Location ("API"), which allows remote clients to query for their devices' locations.1/12/2015
Location API ArchitectureLocationDescribes the Location API architecture including: Production URL, Request / Response Format, HTTP Method, Date / Time Format, Bracketed IDs ("[id]"s), Ellipses ("…"s), PUT Methods and Partial Updates, URL Definitions, and GET Methods and Query Strings3/16/2015
Retrieve Location DataLocationThis method is used to return a device's location coordinates and venue map data.1/14/2015
Location API Response HandlingLocationProvides the HTTP status codes and and error payloads for the location API1/14/2015
MARS API v1.1MARSThis document describes the specification for the MaaS MARS API ("API") and the contract between the API and the mobile SDKs. It describes the payload data delivered by the Cisco MSE for processing by the MARS server.1/13/2015
MARS API ArchitectureMARSProvides the request/response format, HTTP method description, date/time format and, ellipses usage1/13/2015
MARS API MethodMARS

Description of the methods in use with Phunware's MARS API including: Register with MARS, Obtain a MAC Address, Deliver the MAC Address to the MARS Server, Register or Update with Cisco MSE, Upload Map Image Data for a Floor, and Delete Full Bind record.

1/13/2015
MARS API Response HandlingMARSDescription of the HTTP status codes and error payloads.1/13/2015
Use of this software requires review and acceptance of our terms and conditions for developer use located at http://www.phunware.com/terms/

 

  • No labels