@keiser/echip-webusb
Advanced tools
Comparing version 2.3.0 to 2.3.1
{ | ||
"name": "@keiser/echip-webusb", | ||
"version": "2.3.0", | ||
"version": "2.3.1", | ||
"description": "Keiser Air eChip WebUSB Library", | ||
@@ -5,0 +5,0 @@ "keywords": [ |
@@ -15,3 +15,2 @@ # Keiser Air eChip WebUSB Library | ||
## Usage | ||
Import singleton instance from module using preferred module loading technique. | ||
@@ -97,6 +96,8 @@ ```ts | ||
## eChip Capabilities | ||
A single eChip is capable of holding 200 workout sets worth of data from 24 distinct machines. If the eChip is full, machines will replace the oldest workout record on the eChip with new data. It is recommended to completely clear the eChip between uses and to only write the data required for targeting during the current workout session. | ||
## API | ||
### ChipReaderWatcher | ||
The `ChipReaderWatcher` is a singleton class which handles the USB device monitoring and permissions handling. There can be only one `ChipReaderWatcher` instance created within a `window` scope, so the library instantiates the class during import and preserves a single instance for all imports. | ||
@@ -117,3 +118,2 @@ | ||
### ChipReader | ||
The `ChipReader` instance is passed into the `onConnect` callback function and is the interface to the connected Chip Reader device. | ||
@@ -134,3 +134,2 @@ | ||
### BaseChip | ||
The `BaseChip` instance is passed into the `onChipDetect` callback function and is the interface to the connected chip device. There are several different extensions to the base `BaseChip` object that can identified by doing a `instanceOf` check or looking at the `type` property. | ||
@@ -154,7 +153,5 @@ | ||
### TZChip and RTCChip | ||
The `TZChip` and `RTCChip` are class extensions on the `BaseChip` class. They add no additional properties or methods, but allow the identification of chip type and will perform chip set operations automatically when detected. An event issued on the `onData` event indicates that the chips data has been successfully updated. | ||
### DataChip | ||
The `DataChip` class extension on the `BaseChip` class adds additional properties and methods specific to the data chip. | ||
@@ -246,3 +243,2 @@ | ||
### Constants | ||
```ts | ||
@@ -282,2 +278,8 @@ enum Precision { | ||
## Copyright and License | ||
Copyright [Keiser Corporation](http://keiser.com/) under the [MIT license](LICENSE.md). | ||
Copyright © 2020 [Keiser Corporation](http://keiser.com/). | ||
The Keiser eChip WebUSB Library source code and library package are made available through the [MIT license](LICENSE.md). | ||
Using any of this library in connection with any Keiser eChip enabled equipment make you subject to the following agreements. Please read all documents in their entirety as they govern your use of the APIs. | ||
- [API Agreement](https://dev.keiser.com/api-agreement/) | ||
- [Brand Guidelines for Developers](https://dev.keiser.com/brand-guidelines/) |
87955
279