@2hire/cordova-plugin-bleintsdk v0.1.3

@2hire/cordova-plugin-bleintsdk

Cordova plugin for BLEIntSDK

Installation

npm install @2hire/cordova-plugin-bleintsdk

Add the plugin in package.json

{
  "cordova": {
    // ...
    "plugins": {
      // ...
      "@2hire/cordova-plugin-bleintsdk": {},
    }
  }
}

iOS setup

Permissions

In order to your application to use bluetooth add Privacy - Location Always Usage Description key (empty value or not. It is better to define a value to a custom / more user-friendly message).

<edit-config file="*-Info.plist" mode="merge" overwrite="true" target="NSBluetoothAlwaysUsageDescription">
    <string>testing</string>
</edit-config>

Building setup

The SDK uses Swift 5 and has a deployment target of iOS 13. Add these preferences in your Cordova config.xml:

<preference name="deployment-target" value="13" />
<preference name="SwiftVersion" value="5" />

Android setup

Permissions

Add the service dependency in your app/AndroidManifest.xml

<config-file parent="/manifest/application" target="AndroidManifest.xml">
    <service android:enabled="true" android:name="io.twohire.bleintsdk.bluetooth.BluetoothLeService" />
 </config-file>

Building setup

The SDK uses minSdkVersion of 23 which is required to build the app.

<preference name="android-minSdkVersion" value="23" />

The SDK uses Kotlin so the Cordova plugin must be enabled.

<preference name="GradlePluginKotlinEnabled" value="true" />

Since the core Android dependency is available through JitPack it needs to be added to your repos.

// platforms/android/app/repositories.gradle
ext.repos = {
    // ...
    maven { url 'https://jitpack.io' }
}

Usage

Setup a new session

Before creating a session with a vehicle, a server session must be created using start_offline_session endpoint.

Create a BLEIntSDK Client instance with data received from the endpoint. See errors for other error codes.

import type * as SDK from '@2hire/bleintsdk-types';

const commandsHistory: string[] = [];

// ...

// data received from start_offline_session endpoint
const accessDataToken = "session_token";
const publicKey = "board_public_key";
const commands: SDK.Commands = {
  start: "start_command_payload",
  stop: "stop_command_payload",
  end_session: "end_session_command_payload",
};

try {
  const result = await cordova.plugins.BLEIntSDKCordova.sessionSetup(accessDataToken, commands, publicKey);

  console.log(result); // true
} catch (e) {
  if (e.code === "invalid_data") {
    // data supplied is not correct. e.g. wrong format?
  }
}

Connect to a vehicle

Connect to a board and start the session. See errors for other error codes.

// board mac address is received from start_offline_session endpoint
const boardMacAddress = "mac_address";

try {
  // connect to vehicle using `boardMacAddress`
  const result = await cordova.plugins.BLEIntSDKCordova.connect(
    boardMacAddress
  );

  // save base64 result.payload command response
  commandsHistory.push(result.payload)

  console.log(result); // { success: true, payload: "efab2331..." }
} catch (e) {
  if (e.code === "invalid_session") {
    // session is not valid. e.g. call server o get a new one
  }
}

Send a command to a vehicle

Available commands are Start and Stop. See errors for other error codes.

try {
  const result = await cordova.plugins.BLEIntSDKCordova.sendCommand("start");

  // save base64 result.payload command response
  commandsHistory.push(result.payload)

  console.log(result); // { success: true, payload: "efab2331..." }
} catch(e) {
  if (e.code === "timeout") {
    // command timed out. e.g. retry?
  }
}

End a session

End the board session and clear the client instance. After ending a board session all payloads received must be then sent back to the server using end_offline_session. See errors for other error codes.

try {
  const result = await cordova.plugins.BLEIntSDKCordova.endSession();

  // save base64 result.payload command response
  commandsHistory.push(result.payload)

  console.log(result); // { success: true, payload: "efab2331..." }

  // endServerSession(commandsHistory)
} catch(e) {
  if (e.code === "timeout") {
    // command timed out. e.g. retry?
  }
}