Skip to content

Commit fe43267

Browse files
authored
docs: add new binding package information (#60)
1 parent 89f8aff commit fe43267

File tree

3 files changed

+6
-5
lines changed

3 files changed

+6
-5
lines changed

docs/api-serialport.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,10 +27,11 @@ serialport.write('ROBOT POWER ON')
2727

2828
## `SerialPort.Binding`
2929

30-
This package includes the [`@serialport/bindings`](api-bindings.md) package already attached to the stream interface.
30+
This package includes the [`@serialport/bindings-cpp`](api-bindings.md) package already attached to the stream interface.
3131

3232
```js
33-
SerialPort.Binding = require('@serialport/bindings)
33+
// This is done automatically
34+
SerialPort.Binding = require('@serialport/bindings-cpp')
3435
```
3536

3637
## `SerialPort.parsers`

docs/api-stream.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ SerialPort.Binding: Binding
6969

7070
The hardware access binding. `Bindings` are how Node-Serialport talks to the underlying system. This static property is used to set the default binding for any new port created with this constructor. It is also used for `Serialport.list`.
7171

72-
If you're using the `serialport` package, this defaults to `require('@serialport/bindings')`.
72+
If you're using the `serialport` package, this defaults to `require('@serialport/bindings-cpp')`.
7373

7474
## Static Methods
7575

@@ -262,7 +262,7 @@ Arguments:
262262
* {Boolean} [setOptions.dsr=false] sets the dsr flag
263263
* {Boolean} [setOptions.dtr=true] sets the dtr flag
264264
* {Boolean} [setOptions.rts=true] sets the rts flag
265-
* {Boolean} [setOptions.lowLatency=true] enables low latency mode (linux specific - admin rights may be required)
265+
* {Boolean} [setOptions.lowLatency=true] enables low latency mode (linux specific - admin rights may be required)
266266
*/
267267
```
268268

docs/guide-about.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ The [`serialport`](api-serialport.md) package which provides a good set of defau
2828

2929
### Bindings
3030
The Bindings provide a low level interface to work with your serialport. It is possible to use them alone but it's usually easier to use them with an interface.
31-
- [`@serialport/bindings`](api-bindings.md) bindings for Linux, Mac and Windows
31+
- [`@serialport/bindings-cpp`](api-bindings.md) bindings for Linux, Mac and Windows
3232
- [`@serialport/binding-abstract`](api-binding-abstract.md) as an abstract class to use if you're making your own bindings
3333
- [`@serialport/binding-mock`](api-binding-mock.md) for a mock binding package for testing
3434

0 commit comments

Comments
 (0)