pinpoint_sdk 12.2.0-alpha

SDK for development with Pinpoint devices

Pinpoint SDK

A cross-platform (Android/iOS) Flutter plugin for Ultra-Wideband (UWB) positioning with Pinpoint's technology.

Note: this a prerelease and is only meant for wrapping the functions of the geolocator package. It does not yet include any Pinpoint functionality.

The integration of navigation based on Pinpoint's technology will be included in the next release.

Getting started

Requirements

• Flutter (minimum version: 3.27.0)
• Visual Studio Code (minimum version: 1.92.2) or Android Studio (minimum version: Android Studio Giraffe | 2022.3.1)

Supported Platforms

• Android (minimum Android 10, API level 29)
• iOS (minimum 11)

Setup Environment

Add pinpoint_sdk in your pubspec.yaml

dependencies:
  pinpoint_sdk:

and import it wherever you want to use it:

import 'package:pinpoint_sdk/pinpoint_sdk.dart';

Call the function initGeolocator to enable the wrapping of geolocator. This function only needs to be called once, e.g. in the main of your app.

initGeolocator();

Refer to the example app in this SDK for a demonstration of how to use it.

Migration from geolocator

1. add pinpoint_sdk to your pubspec.yaml (cf. above)
2. remove geolocator from the dependencies of your app
3. replace the original import of package:geolocator/geolocator.dart with package:pinpoint_sdk/pinpoint_sdk.dart
4. Call the function initGeolocatorto enable the wrapping in the main of your app:

import 'package:pinpoint_sdk/pinpoint_sdk.dart';
void main () {
  // wraps original GeolocatorPlatform instance
  initGeolocator();
  runApp(const GeolocatorApp());
}

Refer to the usage guide of geolocator for the necessary platform specific adaptations.

Important: When setting up Android, always use the Permission ACCESS_FINE_LOCATION because this is necessary for the Pinpoint SDK. If you use ACCESS_COARSE_LOCATION, this might cause the app to crash.

License

This package is licensed under a proprietary license with MIT licensed components. Please refer to the LICENSE file for more details. Note: The example app for this package uses the plugin flutter_map and is therefor additionally licensed under the BSD-3-Clause (cf. LICENSE file in example folder).