-
Notifications
You must be signed in to change notification settings - Fork 86
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: Document Device UART Protocol Properties (#1299)
Signed-off-by: Elizabeth J Lee <elizabeth.j.lee@intel.com>
- Loading branch information
Showing
2 changed files
with
22 additions
and
0 deletions.
There are no files selected for viewing
21 changes: 21 additions & 0 deletions
21
docs_src/microservices/device/services/device-uart/ProtocolProperties.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
--- | ||
title: Device UART - Protocol Properties | ||
--- | ||
|
||
# Device UART - Protocol Properties | ||
|
||
This service defines the following Protocol Properties for each defined UART device. These properties reside under the `UART` key in the `protocols` section of each device definition. | ||
|
||
| Property | Description | | ||
|----------------|--------------------------------------------------------------------------| | ||
| deviceLocation | Linux path to the device | | ||
| baudRate | Rate information is transferred (bits/second) | | ||
|
||
!!! example - "Example UART Protocol Properties" | ||
|
||
```yaml | ||
protocols: | ||
UART: | ||
deviceLocation: "/dev/ttyAMA2" | ||
baudRate: 115200 | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters