jam-litams-sdk

1.0.3 • Public • Published

Litams SDK

SDK created to implement with a Cordova application, has native Android functions designed for the Litams application.

Functions

Functions that can be invoked with javascript and their parameters and return values.

playSound

Plays a sound and and makes a optional vibration from the device.

Parameters

  • Function (will be used to just return the scanStatus input)
  • Integer (the scanStatus used for the sound, 1 = SUCCESS, 2 = FAIL, 3 = ERROR)
  • Boolean (provide false to have no vibration, provide true to vibrate the device)

canScan

Used to check if a device can actually use a RFID scanner.

Parameters

  • Function (will be used to return a boolean)

isScanning

Used to check if a device is scanning at the moment.

Parameters

  • Function (will be used to return a boolean)

scan

Scan a RFID tag.

Parameters

  • Function (will be used to return a string when scanning is successful)
  • Function (will be used to return a string if scanning failed)
  • Boolean (provide false for a single scan, provide true for multiple scans in a row)
  • Integer (the duration before a scan times out)

stopScan

Stop a RFID multiscan

Parameters

  • Function (will be used to return a string)

startBluetooth

Start a Bluetooth connection

Parameters

  • Function (will be used to return a string, depending if sendBluetoothMessage was used after this function, messages send from the bluetooth device will switch over to the function of sendBluetoothMessage)

sendBluetoothMessage

Send a Bluetooth message

Parameters

  • Function (will be used to return a string, can replace the function of startBluetooth)
  • String (message to send to the receiving device)

stopBluetooth

Stop the Bluetooth connection

Parameters

  • Function (will be used to return a string)

Readme

Keywords

Package Sidebar

Install

npm i jam-litams-sdk

Weekly Downloads

0

Version

1.0.3

License

none

Unpacked Size

12.1 MB

Total Files

65

Last publish

Collaborators

  • martijn.raats.jam-it.nl