MoveDevice

MOVE Models

Since MOVE SDK v2.4

MoveDevice is used to register / unregister relevant car audio devices and beacons if the optional BDD - Device Discovery feature is configured with setup(...). It is also used when the relevant scan results are delivered to the host app.

Till MOVE SDK v2.12.0: After a .shutdown() the previous registered devices will be unregistered.

Since MOVE SDK v2.13.0: The registered Bluetooth devices will be stored in the SDK Backend. After a re-registration / login with the same userId the registered Bluetooth devices are available again.

Android

class MoveDevice internal constructor(
    val id: String,
    val name: String,
    val manufacturerId: Int? = null,
    val isConnected: Boolean = false,
    val uuid: String? = null,
    val major: Int? = null,
    val minor: Int? = null,
    val state: MoveDeviceState = MoveDeviceState.NOT_SYNCHRONIZED,
    val displayName: String = "",
)

iOS

public class MoveDevice {
    public var id: String
    public var name: String
    public var displayName: String
    public var isConnected: Bool
    public var state: MoveDeviceState

    public init(name: String, id: String)
    public init(name: String, proximityUUID: UUID, major: UInt16, minor: UInt16)
    public init(proximityUUID: UUID)
}

React Native

export type MoveSdkDevice = {
    name: string;
    displayName: string;
    data: string;
    id: string;
    isConnected?: boolean;
    state?: MoveSdkDeviceState;
};

Flutter

import 'package:movesdk/io/dolphin/move/move_device.dart';

class MoveDevice {
  String name;
  String data;
  bool isConnected;
  String displayName;
  MoveDeviceState state;
}

MoveDevice	Type
id	String	A device identifier to uniquely identify the device i.e: MAC address. This is used for equality checks. This id is sent to the server during trip device discovery. Note: For Classic Bluetooth devices, the Bluetooth device must be paired with the phone before registration. BLE Beacons do not require pairing.
name	String	The name of the device.
displayName	String	Since MOVE SDK 2.17.0 An editable custom name for the device. defaults to name.
manufacturerId (Android only)	Integer	A company identification of the beacon. You can find a list of companies at www.bluetooth.com.
data (Flutter/React only)	String	Opaque data field to convert to native object.
isConnected	Boolean	Since MOVE SDK v2.9.1 The connection state of the registered MoveDevice. Will be updated via the deviceStateListener.
uuid	String	Since MOVE SDK v2.13.0 Universally Unique Identifier of a group of beacons.
major	Int	Since MOVE SDK v2.13.0 The subgroup within a UUID.
minor	Int	Since MOVE SDK v2.13.0 Used to identify an individual beacon.
state	MoveDeviceState	Since MOVE SDK 2.17.0 A state indicating errors during synchronization of the device with the backend.

MoveDevice related
Device Discovery Listener	Listeners / Callbacks
MoveDevice State Listener	Listeners / Callbacks

Registering all beacons for a Service UUID

To register all beacons for a specific proximity UUID, register a beacon device with empty major, minor.

For Android you can use code like:

Note: MoveDevice cannot be instantiated directly. Use the provided factory methods: createClassicDevice(), createBeacon(), or createBeacons().

fun createBeacons(uuid: String): MoveDevice {
    return MoveDevice(
        id = uuid,
        name = "Beacons $uuid",
        manufacturerId = null,
        isConnected = false,
        uuid = uuid,
        major = null,
        minor = null,
        ...
    )
    
...

MoveSdk.get()?.registerDevices(
    listOf(
        MoveDevice.createBeacons("B325A5E9-F12E-4E60-869A-36FEC22A225A")
    )
)

For react native there is a helper function:

MoveSDK.beaconDevices(serviceUUID)

For Flutter:

// Create a BLE Beacon device
final device = MoveDevice(
  "My Beacon",                                    // name
  '{"uuid":"YOUR-BEACON-UUID","major":1,"minor":1}', // data (JSON)
  false,                                          // isConnected
  "My Beacon Display Name",                       // displayName
  MoveDeviceState.notSynchronized,                // initial state
);

// Register the device
await moveSdk.registerDevices([device]);

// MoveDevice objects are obtained via startScanningDevices().
// For direct registration with a known UUID, use startScanningDevices() 
// with the uuid filter parameter to find the device first.
moveSdk.startScanningDevices(
  filter: [MoveDeviceFilter.beacon],
  uuid: "YOUR-BEACON-UUID",
).listen((items) {
  // Register scanned devices directly
  moveSdk.registerDevices(items);
});

Note: The data field must contain a JSON string with the device identifiers. For BLE beacons include uuid, major, and minor. For Classic Bluetooth devices include the MAC address as id.