From 971c33041c00e384cc436a72ee2873dea0988b01 Mon Sep 17 00:00:00 2001 From: Carles Fernandez Date: Mon, 22 Apr 2019 14:01:37 +0200 Subject: [PATCH] Add README file --- docs/protobuf/README.md | 19 +++++++++++++++++++ docs/protobuf/monitor_pvt.proto | 1 - 2 files changed, 19 insertions(+), 1 deletion(-) create mode 100644 docs/protobuf/README.md diff --git a/docs/protobuf/README.md b/docs/protobuf/README.md new file mode 100644 index 000000000..110f73f28 --- /dev/null +++ b/docs/protobuf/README.md @@ -0,0 +1,19 @@ +# Custom structured data format definitions + +Files in this folder describe structured data formats that are generated by +GNSS-SDR. They use [Protocol Buffers](https://developers.google.com/protocol-buffers/)' +[proto3](https://developers.google.com/protocol-buffers/docs/proto3) syntax. + +From those files, the protocol buffer compiler creates classes that implement +automatic encoding and parsing of the protocol buffer data with an efficient +binary format. The generated classes provide getters and setters for the fields +that make up a protocol buffer and take care of the details of reading and +writing it as a unit. Importantly, the protocol buffer format supports the idea +of extending the format over time in such a way that the code can still read +data encoded with the old format. + +Just grab these files if you are developing a client application for GNSS-SDR. +You are free to use C++, Java, Python, C#, Dart, Go or Ruby, among other +languages. A tutorial to create a simple application using Protocol Buffers and +a `.proto` file in C++ is available at +https://gnss-sdr.org/docs/tutorials/monitoring-software-receiver-internal-status/ diff --git a/docs/protobuf/monitor_pvt.proto b/docs/protobuf/monitor_pvt.proto index 636d715cd..3a2de2397 100644 --- a/docs/protobuf/monitor_pvt.proto +++ b/docs/protobuf/monitor_pvt.proto @@ -5,7 +5,6 @@ package gnss_sdr; /* MonitorPvt represents a search query, with pagination options to * indicate which results to include in the response. */ message MonitorPvt { - uint32 tow_at_current_symbol_ms = 1; // Time of week of the current symbol, in ms uint32 week = 2; // PVT GPS week double rx_time = 3; // PVT GPS time