Skip to content

Commit 8b6875b

Browse files
committed
Add usage as library to readme
1 parent 61d4c43 commit 8b6875b

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -370,6 +370,10 @@ the serial port shows up on the PC. See the example `autoconnect.ini` for config
370370

371371
On Linux you can also use the included systemd (user) service to auto start this on boot.
372372

373+
### Usage as library
374+
ble-serial is primarily designed for command line usage. Nonetheless it is possible to import modules of it into another python application. See the
375+
[`examples/`](https://github.com/Jakeler/ble-serial/tree/master/examples) dir for how to use the ble parts directly.
376+
373377
## Known limitations
374378
* Chromium 73+ based applications, including NW.js/electron desktop apps, for example current Betaflight/INAV Configurator: Connection to the virtual serial port (pty) fails. This is because of explicit whitelisting in chromium.
375379

0 commit comments

Comments
 (0)