Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,14 @@ Either connect to a device via the GUI or command line and include the flag:
```
This will save a `.pickle` file in your current working directory.

**NOTE:** Use of this recording is intended only for debugging the swift-console and not for
long term storage of streams. There is no guarantee the recording will be compatible with
other console versions, as the messaging format between backend and frontend has no guarantee
of backwards or forwards compatibility

Debugging internal messaging should be version specific and recording it should be tied
to its version.

### (Debug) Replaying a stream from the backend in frontend (with or without Rust).
If you have recorded a capnp recording pickle file as shown in the previous step, now you
can replay this file. If you already have the standard development environment set up, you
Expand Down Expand Up @@ -421,6 +429,10 @@ phase -- capnproto also has very ergonomic Python bindings. Other formats such a
[flatbuffers][] achieve similar goals as *capnproto* but do not have good
Python support.

**We do not intend on allowing backward compatibility** in internal message passing via
capnproto. There may be releases that modify internal message structures and should
not be relied on even though these internal packets are being exposed.

[capnproto]: https://capnproto.org/
[flatbuffers]: https://google.github.io/flatbuffers/

Expand Down

This file was deleted.

8 changes: 0 additions & 8 deletions src/main/resources/base/console_backend.capnp
Original file line number Diff line number Diff line change
Expand Up @@ -27,14 +27,6 @@ struct LogLevelFront {
logLevel @0 :Text;
}

enum LogLevel {
err @0;
warning @1;
info @2;
debug @3;
trace @4;
}

struct LogEntry {
timestamp @0 :Text;
level @1 :Text;
Expand Down
4 changes: 3 additions & 1 deletion utils/loop_generate_core.sh
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@
# No interactive debugger is invoked for this script - just crash and
# generate core file for later inspection.

# run with PATH_TO_PICKLE set to specify capnp recording

if [ "$core_pat" != "core" ]; then
echo "/proc/sys/kernel/core_pattern incorrect: '$core_pat', should be 'core'"
echo "Please run the following as root:"
Expand All @@ -22,7 +24,7 @@ I=0
while [ true ]
do
echo "++++++++++++++++++++++" $I
python -m swiftnav_console.main --read-capnp-recording console_backend/tests/data/console-capnp-20220419-033358.pickle
python -m swiftnav_console.main --read-capnp-recording $PATH_TO_PICKLE
if [ $? -ne 0 ]; then
break
fi
Expand Down