A package for ANT on Web browsers.

This repository was based on ant-plus the original module for Node.js by @Loghorn.

📝 This package uses the WebUSB API. This API is not available in some browsers.

npm install web-ant-plus

There are several ways to create a USB stick that can be used to start/create a sensor:

import { GarminStick3 } from "web-ant-plus";
const stick = new GarminStick3();

This method will create a USBDriver (stick) from an ANT USB stick that has already been paired (i.e. will not open the dialog but rather filter for already paired usb devices). Please note that if more than one ANT stick was paired it will chose the first one.

const stick = USBDriver.createFromPairedDevice();

This method will create a USBDriver (stick) from a USBDevice instance. Please note that this does not do any checks whether USBDevice instance is in fact an ANT stick.

const stick = USBDriver.createFromDevice();

This method will open a prompt to pair a usb device to connect to. Once connected it will return a USBDriver instance (stick)

const stick = USBDriver.createFromNewDevice();

const hrSensor = new HeartRateSensor(stick);

hrSensor.on("hbData", function (data: HeartRateSensorState) {
  console.log(data.DeviceID, data.ComputedHeartRate);
});

stick.on("startup", function () {
  hrSensor.attach(0, 0);
});

await stick.open();

Please note that the open() method will resolve the promise only once the stick is closed (or rejected due to an error). In this case it will return the underlying USBDevice instance. In practice this should mean that the open() method, if awaited, is blocking until the communication with stick terminates.

const hrScanner = new HeartRateScanner(stick);

hrScanner.on("hbData", function (data: HeartRateSensorState) {
  console.log(data.DeviceID, data.ComputedHeartRate);
});

stick.on("startup", function () {
  hrScanner.scan();
});

if (!stick.open()) {
  console.log("Stick not found!");
}

• never attach a sensor before receiving the startup event
• never attach a new sensor before receiving the attached or detached event of the previous sensor
• never detach a sensor before receiving the attached or detached event of the previous sensor

GarminStick2 is the driver for ANT sticks with a USB product ID of 0x1008. As well as the old Garmin USB2 ANT stick, this works with many of the common off-brand clones.

GarminStick3 is the driver for the mini Garmin ANT stick which has a USB product ID of 0x1009.

• maxChannels

  • The maximum number of channels that this stick supports; valid only after startup event fired.

• is_present()

  • Checks if the stick is present. Returns true if it is, false otherwise.

• open()

  • Tries to open the stick. Returns a promise that resolves once the stick is closed (or the promise is rejected due to an error). In this case it will return the underlying USBDevice instance. In practice this should mean that the open() method if awaited is blocking until the communication with stick terminates.

• close()

  • Closes the stick.

• reset()

  • Reset the stick and detach all sensors;

• startup

  • Fired after the stick is correctly initialized.

• shutdown

  • Fired after the stick is correctly closed.

• attach(channel: number, deviceID: number)

  • Attaches the sensors, using the specified channel and deviceId (use 0 to connect to the first device found).

• detach()

  • Detaches the sensor.

• attached

  • Fired after the sensor is correctly attached.

• detached

  • Fired after the sensor is correctly detached.

• scan()

  • Attaches the sensors and starts scanning for data from every devices in range.

• detach()

  • Detaches the sensor.

• attached

  • Fired after the sensor is correctly attached.

• detached

  • Fired after the sensor is correctly detached.

• hbData

  • Fired when new heartbeat data is received.

Calibrates the speed sensor. Defaults to a wheel with diameter of 70cm (= 2.199).

• speedData

  • Fired when a new wheel speed is calculated.

• cadenceData

  • Fired when a new pedal cadence is calculated.

• ssdData

  • Fired when new data been calculated.

• powerData

  • Fired when new power has been calculated.

• fitnessData

  • Fired when new data is received.

• envData

  • Fired when data is received.
  • The state.EventCount value can be used to tell when a new measurement has been made by the sensor - it's value will have been incremented.

This software is subject to the ANT  Shared Source License www.thisisant.com/swlicenses
Copyright (c) Garmin Canada Inc. 2018
All rights reserved.