Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Pre-requisites #68

Merged
merged 3 commits into from
May 19, 2024
Merged

Pre-requisites #68

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0f3618f
Pre-requisites section
ianchanning Apr 14, 2024
8820945
Update README.md
ianchanning Apr 14, 2024
d6f2944
Update README.md
chrvadala May 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 14 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,20 @@ Bluetooth Low Energy (BLE) library written with pure Node.js (no bindings) - bak
- [GattService](https://github.com/chrvadala/node-ble/blob/main/docs/api.md#GattService)
- [GattCharacteristic](https://github.com/chrvadala/node-ble/blob/main/docs/api.md#GattCharacteristic)

# Pre-requisites
This library works on many architectures supported by Linux. However Windows and Mac OS are [*not* supported](https://github.com/chrvadala/node-ble/issues/31).

It leverages the `bluez` driver, a component supported by the following platforms and distributions <https://www.bluez.org/about>.

*node-ble* has been tested on the following architectures:
- Raspbian
- Ubuntu
- Debian

```sh
sudo apt install dbus bluetooth bluez libbluetooth-dev libudev-dev
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are you sure that all these dependencies are needed? Usually I don't install them on ubuntu, but maybe that on debian something could be different.
Can you double check?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Based on #31 (comment) - but its hard to tell with the setup I have it has a mix of docker and external debian packages that it uses

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note that its not just Debian, its in a docker node:18-slim container so has any regular packages removed.

```

# Install
```sh
npm install node-ble
Expand Down Expand Up @@ -100,13 +114,6 @@ await device.disconnect()
destroy()
```

# Compatibility
This library works on many architectures supported by Linux.
It leverages on Bluez driver, a component supported by the following platforms and distributions https://www.bluez.org/about

*Node-ble* has been tested on the following environment:
- Raspbian
- Ubuntu
# Changelog
- **0.x** - Beta version
- **1.0** - First official version
Expand Down