Getting Started

dependencies:
  ones1ght_sdk:
    git:
      url: https://github.com/onecheck-inc/OneS1ght-Flutter-SDK
      ref: v0.0.1

import 'package:ones1ght_sdk/ones1ght.dart';

flutter config --enable-swift-package-manager

<key>NSLocationWhenInUseUsageDescription</key>
<string>Used to find your position in the store.</string>
<key>NSNearbyInteractionUsageDescription</key>
<string>Used for precise UWB positioning.</string>
<key>NSBluetoothAlwaysUsageDescription</key>
<string>Used to find nearby positioning devices.</string>
<key>NSLocationTemporaryUsageDescriptionDictionary</key>
<dict>
    <key>Positioning</key>
    <string>Used to calculate your precise indoor position.</string>
</dict>

// android/app/src/main/kotlin/.../MainActivity.kt
import io.flutter.embedding.android.FlutterFragmentActivity

class MainActivity : FlutterFragmentActivity()

android {
    compileSdk = 37
    defaultConfig {
        minSdk = 26
    }
}

await OneS1ght.initialize(sdkKey: 'YOUR_API_KEY');

const sdkKey = String.fromEnvironment('ONES1GHT_SDK_KEY');
await OneS1ght.initialize(sdkKey: sdkKey);

flutter run --dart-define=ONES1GHT_SDK_KEY=ock_sdk_…

switch (await OneS1ght.deviceAvailability()) {
  case DeviceAvailability.available:
    break;
  case DeviceAvailability.osVersionTooLow:
    // "Available after an OS update"
    break;
  case DeviceAvailability.deviceNotSupported:
    // "This device does not support indoor positioning"
    break;
}

final status = await OneS1ght.requestPermission();   // shows the system permission dialog

final profileId = await OneS1ght.createProfile({'gender': 'F', 'ageGroup': '20s'});
// Keep profileId in your app and reuse it on later launches.

await OneS1ght.identify(profileId: profileId);   // required before starting positioning

final buildings = await OneS1ght.buildings();
final floors = await OneS1ght.floors(buildingId: buildings.first.id);
await OneS1ght.setFloorMap(floors.first, buildingId: buildings.first.id);

final session = await OneS1ght.floorSession();
session.onFloorDetected.listen((floorId) async {
  if (floorId == null) return;   // floor lost
  final floor = await OneS1ght.floor(buildingId: buildingId, floorId: floorId);
  await OneS1ght.setFloorMap(floor, buildingId: buildingId);
});

final floor = await OneS1ght.floor(buildingId: buildingId, floorId: floorId);
if (floor.image != null) Image.memory(floor.image!);

final session = await OneS1ght.floorSession();   // always the same instance
await session.begin();   // when entering the store
// ...
await session.end();     // stop + upload remaining positions. Initialization and floor are kept

await session.pause();    // stops only display, collection and judgement; the engine keeps the floor
await session.resume();   // continues right away

session.onStopped.listen((reason) {
  if (reason == StopReason.engineFailed) {
    // Fix the cause (permission, Bluetooth, …) and open it again with begin()
  }
});

session.onZoneEnter.listen((zone) => debugPrint('IN  ${zone.name}'));
session.onZoneExit.listen((zone) => debugPrint('OUT ${zone.name}'));
session.onZoneDwell.listen((d) => debugPrint('DWELL ${d.zone.name} ${d.seconds}s'));
session.onPosition.listen((c) => debugPrint('${c.x}, ${c.y}'));   // floor-local metres
session.onTriggers.listen((t) {
  for (final trigger in t.triggers) {
    // trigger.type: signage · coupon · tracking · merch · generic (new values may be added)
  }
});

final zones = await OneS1ght.refreshZones();   // re-reads only the current floor's zones (no floor plan download)

session.onConfigChanged.listen((change) {
  switch (change) {
    case ZonesChanged() || ResyncNeeded():
      scheduleZoneRefresh();      // collect for about 1 s, then OneS1ght.refreshZones() once
    case PlanChanged(:final floorId):
      redrawFloor(floorId);       // fetch floor() again and redraw the map
    case RulesChanged(:final zoneId):
      recheckZoneEvents(zoneId);  // if the user is in that zone, query its events once more
    default:
      break;
  }
});

await OneS1ght.uploadPendingPositions();    // upload buffered positions now
await OneS1ght.discardPendingPositions();   // drop buffered positions without uploading

await OneS1ght.reset();   // drops the session — you can initialize with another key

try {
  await session.begin();
} on OneS1ghtException catch (e) {
  switch (e.code) {
    case 'E1004':
      await OneS1ght.identify(profileId: savedProfileId);   // connect the profile, then start again
    case 'E2001' || 'E2002':
      showUnsupportedNotice();                              // tell the user the device cannot position
    default:
      debugPrint('${e.code} ${e.message}');
  }
}

import 'package:flutter/foundation.dart';   // kDebugMode · debugPrint

if (kDebugMode) {
  OneS1ght.onDebugLog.listen((log) => debugPrint('OneS1ght $log'));
}