Skip to content

Commit

Permalink
feat: Document Device UART Protocol Properties (#1299)
Browse files Browse the repository at this point in the history
Signed-off-by: Elizabeth J Lee <elizabeth.j.lee@intel.com>
  • Loading branch information
ejlee3 authored Nov 13, 2023
1 parent e72b3cf commit 6b8c159
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 0 deletions.
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
```
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -228,6 +228,7 @@ nav:
- Purpose: microservices/device/services/device-uart/Purpose.md
- Getting Started: microservices/device/services/device-uart/GettingStarted.md
- Configuration: microservices/device/services/device-uart/Configuration.md
- Protocol Properties: microservices/device/services/device-uart/ProtocolProperties.md
- API Reference: microservices/device/services/device-uart/APIReference.md
- Source Code: microservices/device/services/device-uart/SourceCode.md
- Device USB Camera:
Expand Down

0 comments on commit 6b8c159

Please sign in to comment.