jacdac-ts/docs/index.md

28 строки
757 B
Markdown
Исходник Обычный вид История

2020-06-23 06:39:11 +03:00
# JACDAC TypeScript
This repository contains a TypeScript/JavaScript client library for the [JACDAC](https://microsoft.github.io/jacdac) protocol.
2020-06-23 16:58:33 +03:00
## Usage: npm + TypeScript
2020-06-23 06:39:11 +03:00
2020-06-23 17:04:37 +03:00
Add the [jacdac-ts npm](https://www.npmjs.com/package/jacdac-ts) module to your project.
2020-06-23 16:58:33 +03:00
```
npm install --save jacdac-ts
```
2020-06-23 17:04:37 +03:00
Import the library in your Typescript project.
2020-06-23 06:39:11 +03:00
```javascript
2020-06-23 16:58:33 +03:00
import * from 'jacdac-ts'
2020-06-23 06:39:11 +03:00
```
2020-06-23 17:04:37 +03:00
2020-06-24 03:25:57 +03:00
## Online tools
2020-06-24 09:07:50 +03:00
A list of sample tools to operate on JACDAC devices, built with this library.
2020-06-24 03:25:57 +03:00
2020-06-24 03:34:29 +03:00
* [packets](./tools/packets), sniff all packets on the bus
* [devices](./tools/devices), list of connected devices
2020-06-24 08:35:37 +03:00
* [console](./tools/console), turns on verbose console and display messages
2020-06-24 09:02:02 +03:00
* [streaming](./tools/streaming), notify sensors to stream sensor data
2020-06-24 08:35:37 +03:00