https://github.com/vviktorpl/acgam-t02p-node
ACGAM T02P Treadmill BLE communication library
https://github.com/vviktorpl/acgam-t02p-node
Last synced: 3 months ago
JSON representation
ACGAM T02P Treadmill BLE communication library
- Host: GitHub
- URL: https://github.com/vviktorpl/acgam-t02p-node
- Owner: vViktorPL
- License: mit
- Created: 2023-01-15T08:54:37.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-03-22T21:04:03.000Z (about 2 years ago)
- Last Synced: 2025-01-11T14:25:40.367Z (4 months ago)
- Language: TypeScript
- Size: 99.6 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# acgam-t02p
[ACGAM T02P Treadmill](https://www.acgam.com/collections/treadmill/products/acgam-2-in-1-folding-treadmill-with-remote-control-and-led-display-installation-free-under-desk-electric-treadmill) BLE communication library for Node.js.
It can be easily used for instance on Raspberry Pi 4 with Raspbian OS
to grab live stats from your treadmill.
## Installation
```bash
npm i acgam-t02p
```
## Example usage
```typescript
import { BluetoothDeviceAddress, TreadmillConnection, TreadmillStatus } from 'acgam-t02p';
const DEVICE_ADDRESS = 'FF:FF:FF:FF:FF:FF'; // TODO: Change with your real device address
(async () => {
const connection = await TreadmillConnection.forAddress(
BluetoothDeviceAddress.fromString(DEVICE_ADDRESS)
);
connection.addStatusNotificationEventListener(handleNotification);
})();
function handleNotification(status: TreadmillStatus) {
console.log(status);
}
```
## API
### TreadmillConnection
This is main class that enables you to maintain a connection and communication
with treadmill device.
### BluetoothDeviceAddress
Helper value object that stores valid bluetooth device address.
### TreadmillStatus
It's data structure that will come into your treadmill status notification listener:
```
type TreadmillStatus
= { status: 'STANDBY' }
| { status: 'STOPPED' }
| { status: 'WAKING_UP' }
| { status: 'PRESTART' }
| { status: 'STARTING'; countdown: number }
| {
status: 'RUNNING' | 'STOPPING';
elapsedSeconds: number;
distanceInMeters: number;
speed: {
currentKmh: number;
targetKmh: number;
};
};
```
Example status data with its interpretation:
| JSON | Interpretation |
|-----------------------------------------------------------------------------------------------------------------|----------------------|
| `{ "status": "STOPPED" }` | Treadmill is stopped |
| `{ "status": "STARTING", "countdown": 5 }` | Treadmill is going to start and it's 5 seconds until start. |
| `{ "status": "RUNNING", "elapsedSeconds": 330, "distanceInMeters": 1500, "speed": { "currentKmh": 11.5, "targetKmh": 8 } }` | Treadmill is running. Elapsed time: 5 minutes 30 seconds. Distance: 1.5km. Current speed 11.5 km/h and it's slowly descending to target 8 km/h.|