From 6b8c159bbb6f15b7bb3d215072059ced810ce1d0 Mon Sep 17 00:00:00 2001 From: ejlee-intel Date: Mon, 13 Nov 2023 16:52:32 -0700 Subject: [PATCH] feat: Document Device UART Protocol Properties (#1299) Signed-off-by: Elizabeth J Lee --- .../device-uart/ProtocolProperties.md | 21 +++++++++++++++++++ mkdocs.yml | 1 + 2 files changed, 22 insertions(+) create mode 100644 docs_src/microservices/device/services/device-uart/ProtocolProperties.md diff --git a/docs_src/microservices/device/services/device-uart/ProtocolProperties.md b/docs_src/microservices/device/services/device-uart/ProtocolProperties.md new file mode 100644 index 000000000..f73dc9947 --- /dev/null +++ b/docs_src/microservices/device/services/device-uart/ProtocolProperties.md @@ -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 + ``` \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index b73476150..4e26a36b6 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -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: