https://github.com/symbitic/node-simpleble

Bluetooth LE bindings for Node, Deno and Bun using SimpleBLE.
https://github.com/symbitic/node-simpleble

ble bluetooth bun deno node-addon-api nodejs simplebe

Last synced: about 1 month ago
JSON representation

Bluetooth LE bindings for Node, Deno and Bun using SimpleBLE.

• Host: GitHub
• URL: https://github.com/symbitic/node-simpleble
• Owner: Symbitic
• License: mit
• Created: 2022-10-16T15:39:16.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2023-02-14T15:42:19.000Z (almost 2 years ago)
• Last Synced: 2024-11-14T03:08:01.117Z (about 1 month ago)
• Topics: ble, bluetooth, bun, deno, node-addon-api, nodejs, simplebe
• Language: TypeScript
• Homepage:
• Size: 215 KB
• Stars: 5
• Watchers: 2
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# Node-SimpleBLE

[![Tags](https://img.shields.io/github/release/Symbitic/node-simpleble)](https://github.com/Symbitic/node-simpleble/releases)

[![Checks](https://github.com/Symbitic/node-simpleble/actions/workflows/test.yml/badge.svg)](https://github.com/Symbitic/node-simpleble/actions/workflows/test.yml)

[![License](https://img.shields.io/github/license/Symbitic/node-simpleble)](https://github.com/Symbitic/node-simpleble/blob/master/LICENSE)

Bluetooth Low Energy (BLE) library for Node, Deno, and Bun using the excellent

[SimpleBLE](https://github.com/OpenBluetoothToolbox/SimpleBLE) library.

## Installing

How you install node-simpleble depends on which runtime you are using.

### Node.js

    npm install --save simpleble

```ts

import { resolveBindings } from "simpleble";

```

### Bun.sh

    bun install simpleble

```ts

import { resolveBindings } from "simpleble";

```

### Deno

```ts

import { resolveBindings } from "https://deno.land/x/[email protected]/mod.ts";

```

## Documentation

Check out the latest documentation here:

## Building

Node-SimpleBLE depends on SimpleBLE, so make sure submodules are checked out first:

    git submodule init

    git submodule update

To build Node-SimpleBLE:

    npm run build

## Running

After building SimpleBLE and the bindings, run one of the examples:

    deno run -A --unstable https://deno.land/x/[email protected]/examples/deno/scan.ts

    deno run -A --unstable ./deno_dist/examples/deno/scan.ts

    npx ts-node-esm ./examples/node/scan.ts

## License

Released under the [MIT License](LICENSE).