https://github.com/Timeular/noble-mac

Noble MacOS bindings using the official CoreBluetooth API
https://github.com/Timeular/noble-mac

ble corebluetooth-api macos nodejs

Last synced: 3 months ago
JSON representation

Noble MacOS bindings using the official CoreBluetooth API

• Host: GitHub
• URL: https://github.com/Timeular/noble-mac
• Owner: Timeular
• License: mit
• Created: 2018-09-18T09:03:05.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2021-09-01T05:53:11.000Z (about 3 years ago)
• Last Synced: 2024-07-18T20:47:34.749Z (4 months ago)
• Topics: ble, corebluetooth-api, macos, nodejs
• Language: Objective-C++
• Homepage:
• Size: 66.4 KB
• Stars: 94
• Watchers: 6
• Forks: 34
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        

> Note: this project was integrated in [@abandonware/noble](https://github.com/abandonware/noble) and is no longer actively maintained

# Noble (Node.js Bluetooth LE) for MacOS

[![Build Status](https://travis-ci.com/Timeular/noble-mac.svg?branch=master)](https://travis-ci.com/Timeular/noble-mac)

_The mac bindings in the [`noble`](https://github.com/sandeepmistry/noble) repository use a XPC connection and an undocumented protocol to communicate directly with the bluetooth daemon.

This is error prone, as the protocol needs to be reverse engineered by sniffing the communication between a regular program which uses the official CoreBluetooth API and the 

bluetooth daemon. Since the protocol is not public Apple can change it at anytime (For now every new OSX release changed the protocol)._

This package provides the same functionality as the regular noble mac bindings using the official [CoreBluetooth API](https://developer.apple.com/documentation/corebluetooth).

## System Requirements

 * Node.js v6.14.2 or later.

 * macOS 10.7 or later

## Prerequisites

### OS X

 * install [Xcode](https://itunes.apple.com/ca/app/xcode/id497799835?mt=12)

## Installation

Currently, it has not been published yet on `npm`, so please try to add the dependence as the following.

```json

"dependencies": {

    "noble-mac": "https://github.com/Timeular/noble-mac.git"

}

```

Then, please run `npm install` again.

## Usage

Simply require `noble-mac` instead of `noble`:

```javascript

const noble = require('noble-mac');

```

On non-Mac platforms this will use the regular [noble](https://github.com/sandeepmistry/noble/blob/master/README.md) implementation and on MacOS it will use the native binding using the official CoreBluetooth API.

## Note

Be careful to not write to the `Client Characteristic Configuration` descriptor directly to enable notification.

Use `subscribe` instead to enable and listen to notifications.

## Implementation Status

Everything should work that also works with the regular noble mac bindings.

 * Broadcast is not implemented, but it neither was in recent noble mac bindings