mirror of
https://github.com/jwetzell/showbridge-docs.git
synced 2026-08-14 01:53:37 +00:00
work on auto-generating parts of docs from JSONSchema
This commit is contained in:
@@ -4,7 +4,7 @@ sidebar:
|
||||
label: Client
|
||||
order: 1
|
||||
---
|
||||
|
||||
import SchemaInfo from '../../../../components/SchemaInfo.astro';
|
||||
import { Aside } from "@astrojs/starlight/components";
|
||||
|
||||
<Aside type="caution">
|
||||
@@ -14,16 +14,7 @@ import { Aside } from "@astrojs/starlight/components";
|
||||
|
||||
The `serial.client` module connects to a serial device and emits a message messages based on the data it receives from the port. Messages are determined by "framing" techniques as serial is a stream based protocol.
|
||||
|
||||
- **type**: `serial.client`
|
||||
- **params**:
|
||||
- **port**: serial port to connect to i.e `/dev/ttyS0`
|
||||
- **baudRate** baud rate to use when connecting to serial port
|
||||
- **framing**: how to chunk the serial stream into "messages"
|
||||
- LF `\n`
|
||||
- CR `\r`
|
||||
- CRLF `\r\n`
|
||||
- [SLIP](https://en.wikipedia.org/wiki/Serial_Line_Internet_Protocol)
|
||||
- RAW (no framing is done bytes are sent out as they are received)
|
||||
<SchemaInfo type="module" id="serial.client"></SchemaInfo>
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
Reference in New Issue
Block a user