From bb5bd30e4e70dd47585e0af1d697545820aa4ddf Mon Sep 17 00:00:00 2001 From: Robin Mueller Date: Thu, 8 Feb 2024 14:14:13 +0100 Subject: [PATCH] update communication chapter --- satrs-book/src/communication.md | 12 +++++++++--- satrs-example/src/tcp.rs | 2 -- 2 files changed, 9 insertions(+), 5 deletions(-) diff --git a/satrs-book/src/communication.md b/satrs-book/src/communication.md index 8e8acd7..ba2aa30 100644 --- a/satrs-book/src/communication.md +++ b/satrs-book/src/communication.md @@ -15,10 +15,16 @@ it is still centered around small packets. `sat-rs` provides support for these E standards and also attempts to fill the gap to the internet protocol by providing the following components. -1. [UDP TMTC Server](https://docs.rs/satrs-core/0.1.0-alpha.0/satrs_core/hal/host/udp_server/index.html#). +1. [UDP TMTC Server](https://docs.rs/satrs-core/hal/host/udp_server/index.html). UDP is already packet based which makes it an excellent fit for exchanging space packets. -2. TCP TMTC Server. This is a stream based protocol, so the server uses the COBS framing protocol - to always deliver complete packets. +2. [TCP TMTC Server Components](https://docs.rs/satrs-core/0.1.0-alpha.1/satrs_core/hal/std/tcp_server/index.html). + TCP is a stream based protocol, so the framework provides building blocks to parse telemetry + from an arbitrary bytestream. Two concrete implementations are provided: + - [TCP spacepackets server](https://docs.rs/satrs-core/0.1.0-alpha.1/satrs_core/hal/std/tcp_server/struct.TcpSpacepacketsServer.html) + to parse tightly packed CCSDS Spacepackets. + - [TCP COBS server](https://docs.rs/satrs-core/0.1.0-alpha.1/satrs_core/hal/std/tcp_server/struct.TcpTmtcInCobsServer.html) + to parse generic frames wrapped with the + [COBS protocol](https://en.wikipedia.org/wiki/Consistent_Overhead_Byte_Stuffing). # Working with telemetry and telecommands (TMTC) diff --git a/satrs-example/src/tcp.rs b/satrs-example/src/tcp.rs index c0934e0..b9f3052 100644 --- a/satrs-example/src/tcp.rs +++ b/satrs-example/src/tcp.rs @@ -76,7 +76,6 @@ pub struct TcpTask { SyncTcpTmSource, CcsdsDistributor, >, - phantom: std::marker::PhantomData, } impl TcpTask { @@ -92,7 +91,6 @@ impl TcpTask { tc_receiver, Box::new(PACKET_ID_LOOKUP), )?, - phantom: std::marker::PhantomData, }) }