simplejsble 1.2.1-dev105 → 1.2.1-dev106
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md
CHANGED
|
@@ -1,15 +1,34 @@
|
|
|
1
1
|
<p align="center">
|
|
2
|
-
<
|
|
3
|
-
|
|
2
|
+
<picture>
|
|
3
|
+
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/simpleble/simpleble/main/docs/public/simpleBLE-logo.png">
|
|
4
|
+
<img src="https://raw.githubusercontent.com/simpleble/simpleble/main/docs/public/simpleBLE-logo-dark.png" alt="SimpleBLE" width="360">
|
|
5
|
+
</picture>
|
|
4
6
|
</p>
|
|
5
7
|
|
|
6
8
|
# SimpleJSBLE
|
|
7
9
|
|
|
10
|
+
**Build Bluetooth once. Ship it everywhere.**
|
|
11
|
+
|
|
8
12
|
SimpleJSBLE brings [SimpleBLE](https://github.com/simpleble/simpleble) to Node.js
|
|
9
13
|
and Electron on Windows, macOS, and Linux. Discover and connect Bluetooth
|
|
10
14
|
peripherals, read and write GATT values, subscribe to notifications, and host
|
|
11
15
|
local GATT services through one API, with TypeScript types included.
|
|
12
16
|
|
|
17
|
+
## Why SimpleJSBLE
|
|
18
|
+
|
|
19
|
+
- **One cross-platform API:** Keep your Bluetooth code the same in Node.js and Electron on Windows, macOS, and Linux.
|
|
20
|
+
- **Native underneath:** Use WinRT, CoreBluetooth, and BlueZ through one maintained stack.
|
|
21
|
+
- **Built for real products:** Act as a central or a peripheral on every supported platform.
|
|
22
|
+
- **Commercially supported:** Ship proprietary applications with commercial licensing and direct technical support from the team that builds SimpleBLE.
|
|
23
|
+
|
|
24
|
+
## Support and resources
|
|
25
|
+
|
|
26
|
+
- **Documentation:** The [usage guide](https://docs.simpleble.org/simplejsble/usage?utm_source=npm&utm_medium=referral&utm_campaign=simplejsble_readme&utm_content=support) and [examples](https://github.com/simpleble/simpleble/tree/main/examples/simplejsble) cover every API.
|
|
27
|
+
- **Commercial support:** Visit [simpleble.org](https://simpleble.org/?utm_source=npm&utm_medium=referral&utm_campaign=simplejsble_readme&utm_content=support) or [email us](mailto:contact@simpleble.org) about licensing and professional services.
|
|
28
|
+
- **Community:** Ask questions and share projects in [GitHub Discussions](https://github.com/simpleble/simpleble/discussions).
|
|
29
|
+
- **Dongl:** Prototype and ship with the [official SimpleBLE USB adapter](https://www.simpleble.org/dongl?utm_source=npm&utm_medium=referral&utm_campaign=simplejsble_readme&utm_content=support).
|
|
30
|
+
- **Contribute:** Send changes to [simpleble/simpleble](https://github.com/simpleble/simpleble/tree/main/simplejsble); the [publishing guide](https://github.com/simpleble/simpleble/blob/main/docs/extras/simplejsble-publishing.md) covers builds and releases.
|
|
31
|
+
|
|
13
32
|
## Get started
|
|
14
33
|
|
|
15
34
|
Use Node.js 22 or newer:
|
|
@@ -29,7 +48,7 @@ import { Adapter } from 'simplejsble';
|
|
|
29
48
|
const [adapter] = await Adapter.getAdapters();
|
|
30
49
|
|
|
31
50
|
adapter.on('scanFound', peripheral => {
|
|
32
|
-
console.log(peripheral.identifier()
|
|
51
|
+
console.log(`${peripheral.identifier()} [${peripheral.address()}] ${peripheral.rssi()} dBm`);
|
|
33
52
|
});
|
|
34
53
|
await adapter.scanFor(5000);
|
|
35
54
|
```
|
|
@@ -101,7 +120,7 @@ changing them.
|
|
|
101
120
|
|
|
102
121
|
## Use a Dongl
|
|
103
122
|
|
|
104
|
-
A [Dongl](https://docs.simpleble.org/dongl) is a USB Bluetooth adapter made for
|
|
123
|
+
A [Dongl](https://docs.simpleble.org/dongl?utm_source=npm&utm_medium=referral&utm_campaign=simplejsble_readme&utm_content=dongl) is a USB Bluetooth adapter made for
|
|
105
124
|
SimpleBLE. Its backend is on by default; use the adapters of the Dongl backend:
|
|
106
125
|
|
|
107
126
|
```js
|
|
@@ -137,8 +156,8 @@ apps need an `NSBluetoothAlwaysUsageDescription` entry in their `Info.plist`.
|
|
|
137
156
|
| Windows 10 or newer | x64, arm64 | |
|
|
138
157
|
| Linux with glibc 2.28 or newer | x64, arm64 | BlueZ and the D-Bus library |
|
|
139
158
|
|
|
140
|
-
See
|
|
141
|
-
|
|
159
|
+
See [Bluetooth permissions](https://docs.simpleble.org/fundamentals/permissions?utm_source=npm&utm_medium=referral&utm_campaign=simplejsble_readme&utm_content=platforms)
|
|
160
|
+
for the setup each platform needs.
|
|
142
161
|
|
|
143
162
|
## Versions
|
|
144
163
|
|
|
@@ -149,24 +168,16 @@ under the `latest` tag, and development builds of the main branch under `dev`:
|
|
|
149
168
|
npm install simplejsble@dev
|
|
150
169
|
```
|
|
151
170
|
|
|
152
|
-
## Documentation and support
|
|
153
|
-
|
|
154
|
-
- Read the [SimpleJSBLE usage guide](https://docs.simpleble.org/simplejsble/usage).
|
|
155
|
-
- Browse the [examples](https://github.com/simpleble/simpleble/tree/main/examples/simplejsble).
|
|
156
|
-
- Join the [Discord community](https://discord.gg/N9HqNEcvP3).
|
|
157
|
-
- Contribute in [simpleble/simpleble](https://github.com/simpleble/simpleble/tree/main/simplejsble); see the [development and publishing guide](https://github.com/simpleble/simpleble/blob/main/docs/extras/simplejsble-publishing.md).
|
|
158
|
-
- Visit [simpleble.org](https://simpleble.org/) for commercial licensing and professional services.
|
|
159
|
-
|
|
160
171
|
## License
|
|
161
172
|
|
|
162
173
|
SimpleJSBLE follows the [SimpleBLE license](https://github.com/simpleble/simpleble/blob/main/LICENSE.md),
|
|
163
174
|
the Business Source License 1.1 (BUSL-1.1). It is free for non-commercial use,
|
|
164
175
|
and commercial use needs a commercial license. We offer free commercial licenses
|
|
165
176
|
for small projects and early-stage companies: [email us](mailto:contact@simpleble.org)
|
|
166
|
-
or [leave us a message](https://www.simpleble.org/contact) to discuss your use
|
|
177
|
+
or [leave us a message](https://www.simpleble.org/contact?utm_source=npm&utm_medium=referral&utm_campaign=simplejsble_readme&utm_content=license) to discuss your use
|
|
167
178
|
case. Commercial licenses carry no royalties or revenue sharing; see the
|
|
168
|
-
[licensing page](https://docs.simpleble.org/licensing) for terms.
|
|
179
|
+
[licensing page](https://docs.simpleble.org/licensing?utm_source=npm&utm_medium=referral&utm_campaign=simplejsble_readme&utm_content=license) for terms.
|
|
169
180
|
|
|
170
181
|
---
|
|
171
182
|
|
|
172
|
-
**SimpleBLE** is a project powered by [The California Open Source Company](https://californiaopensource.com
|
|
183
|
+
**SimpleBLE** is a project powered by [The California Open Source Company](https://californiaopensource.com/?utm_source=npm&utm_medium=referral&utm_campaign=simplejsble_readme&utm_content=footer).
|
package/package.json
CHANGED
|
Binary file
|
|
Binary file
|