npm

Need private packages and team management tools?Check out npm Orgs. »

cordova-plugin-antplus

0.8.1 • Public • Published

ANT+ plugin for Apache Cordova

This plugin enables communication between Android phone and ANT+ devices

Originally created for MoBio app:

Supported Platforms

  • Android

ANT support

In order to use this plugin install the following apps to your phone. The apps enable the communication with ANT+ OTG modul if you are using it.

Installing

Cordova

$ cordova plugin add cordova-plugin-antplus

API

Methods

Description of the methods will be added soon.

searchDevices

Search and discover ANT+ devices.

antplus.searchDevices(comma_separated_device_definition, success, failure)

Description

Function searchDevices scans for the defined ANT+ devices. Success callback is called every time the a device is discovered. First parameter is string - comma separated values of device types that the function scans for. Possible values are:

  • HEARTRATE
  • BIKE_SPD
  • BIKE_CADENCE
  • BIKE_SPDCAD
  • STRIDE_SDM
  • WEIGHT_SCALE

success response parameters

  • resultID
  • describeContents
  • antDeviceNumber
  • antDeviceType
  • deviceDisplayName
  • isAlreadyConnected
  • isPreferredDevice
  • isUserRecognizedDevice

error response parameters

  • event
  • message
  • code

Example

antplus.searchDevices('BIKE_SPD,BIKE_CADENCE,BIKE_SPDCAD', function(device) {
    console.log(JSON.stringify(device));
}, failure);

stopSearchDevices

Terminate scanning for ANT devices.

antplus.stopSearchDevices(success, failure)

subscribeHR

Function subscribeHR starts listening for Heart rate monitor events. The first parameter is antDeviceNumber returned from antplus.searchDevices. Success callback is called every time the an event is generated. Each event has different type and data. Events are distinguished by the parameter event.

Example

antplus.subscribeHR(antDeviceNumber, function(response) {
    console.log(JSON.stringify(response));
}, failure);

success callback parameters

  • antDeviceNumber
  • timestamp
  • event: 'heartRateData'
    • eventFlags
    • heartRate
    • heartBeatCount
    • heartBeatEventTime
    • dataState
  • event: 'page4AddtData'
    • eventFlags
    • estTimestamp
    • manufacturerSpecificByte
    • previousHeartBeatEventTime
  • event: 'cumulativeOperatingTime'
    • eventFlags
    • estTimestamp
    • cumulativeOperatingTime
  • event: 'manufacturerAndSerial'
    • eventFlags
    • estTimestamp
    • manufacturerID
    • serialNumber
  • event: 'versionAndModelEvent'
    • eventFlags
    • estTimestamp
    • hardwareVersion
    • softwareVersion
    • modelNumber
  • event: 'calculatedRrIntervalEvent'
    • eventFlags
    • estTimestamp
    • rrInterval
    • flag

error callback parameters

  • event: 'error'
  • message
  • code
  • antDeviceNumber

unsubscribeHR

Terminate listening for Heart rate monitor events.

antplus.unsubscribeHR(success, failure)

subscribeWGT

Function subscribeWGT starts listening for Weight scale events. The first parameter is antDeviceNumber returned from antplus.searchDevices. Success callback is called every time the an event is generated. Each event has different type and data. Events are distinguished by the parameter event.

Example

antplus.subscribeWGT(antDeviceNumber, function(response) {
    console.log(JSON.stringify(response));
}, failure);

success callback parameters

  • antDeviceNumber
  • timestamp
  • event: 'bodyWeightBroadcastData'
    • eventFlags
    • estTimestamp
    • bodyWeightStatus
    • bodyWeight (note: present only if bodyWeightStatus == 'VALID')
  • event: 'manufacturerIdentificationData'
    • eventFlags
    • estTimestamp
    • hardwareRevision
    • manufacturerID
    • modelNumber
  • event: 'productInformationData'
    • eventFlags
    • estTimestamp
    • mainSoftwareRevision
    • supplementalSoftwareRevision
    • serialNumber

error callback parameters (common for above)

  • event: 'error'
  • message
  • code
  • antDeviceNumber

install

npm i cordova-plugin-antplus

Downloadsweekly downloads

8

version

0.8.1

license

Apache-2.0

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability