README
¶
Trice <- TRace Ids C Embedded
"log in (a) trice" (S>G) 
About
- Replace
printforlogin C-code for getting: - Main idea: Logging strings not into an embedded device to display them later on a PC but keep usage comfortable and simple.
- Trice consists of 2 parts:
- C code
TRICEmacros generating tiny & super-fast embedded device real-time trace/log code - Tool trice for managing and visualization.
- Written in Go and therefore usable on all platforms Go supports.
- You can also use your own environment to receive the Trice packages, exchange the carried IDs with the format string and print out.
- C code
- Trice User guide
Possible Use Cases
- Using Trice not only for printf debugging but also as logging technique is possible and gives the advantage to have very short messages (no strings) for transmission, but keep in mind that the file til.json is the key to read all output if your devices in the field for 10 or more years.
- You can see Trice also as a kind of data compression what could be interesting for IoT things, especially NB-IoT, where you have very low data rates.
- Storing Trice messages in FLASH memory for later log analysis saves memory because a typical
TRICEoccupies only about 4-8 bytes independently of the format string length. - Also, it is possible to encrypt the Trice transfer packets to get a reasonable protection for many cases.
- This way you can deliver firmware images with encrypted Trice output, only readable with the appropriate key and til.json.
- XTEA is implemented as one option.
- You can even translate the til.json file in different languages, so changing a language is just changing the til.json file without touching the target binary.
- With Trice it is easy to do timing analysis on distributed embedded systems. Host and target timestamps are supported.
How it approximately works (UART example)
This slightly simplified view is explained here
Data Transfer
- Implemented:
- UART connectable to virtual UART over USB
- RTT over J-Link and RTT over ST-Link
- A small separate microcontroller is always usable as interfaces bridge to GPIO, I²C, SPI, CAN, LIN, ...
- With a Chip from FTDI, check for example Adafruit FT232H Breakout, GPIO, I2C and SPI are easy accessable.
Display server option
Start trice ds inside a console, option: third_party/alacritty, locally or on a remote PC and connect with several trice tool instances like with trice log -p COM15 -ds for example.
Documentation
- https://interrupt.memfault.com/blog/trice
- Trice User Guide
- Check the docs folder. No need to read all this stuff - it is just for help and reference.
Support?
Yes please - or simply ⭐ it. ☺
Cloning the repo:
git clone https://github.com/rokath/trice.git
Similar projects
- baical.net (C)
- call stack logger function instrumentation (a way to trace programs flow of execution)
- Debugging with Dynamic Printf Breakpoints (Eclipse IDE option)
- defmt (Rust)
- elog (Embedded logger with minimal footprint and memory usage)
- J-Link System View (SEGGER)
- Logging with symbols - The Embedonomicon
- Memfault Compact Log Library
- Metal Serial Library
- Minimal Structured Logging for Autonomous Vehikles (C++, closed source talk)
- NanoLog (Linux C++)
- Percepio Tracealyzer (Visual Trace Diagnostics)
- Pigweed Trace Tokenized
- qpspy (C/C++)
- Serial-Studio (Data visualisation)
- Traces (API tracing framework for Linux C/C++ applications
- Zepyr Dictionary Based Logging
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
cui
command
|
|
|
stim
command
|
|
|
trice
command
|
|
|
internal
|
|
|
args
Package args implements the commandline interface and calls the appropriate commands.
|
Package args implements the commandline interface and calls the appropriate commands. |
|
charDecoder
Package charDecoder provides a decoder char encoded trice streams.
|
Package charDecoder provides a decoder char encoded trice streams. |
|
com
Package com reads from COM port.
|
Package com reads from COM port. |
|
decoder
Package decoder provides several decoders for differently encoded trice streams.
|
Package decoder provides several decoders for differently encoded trice streams. |
|
dumpDecoder
Package dumpDecoder provides a decoder dumping encoded trice stream.
|
Package dumpDecoder provides a decoder dumping encoded trice stream. |
|
emitter
Package emitter emits the translated trice strings.
|
Package emitter emits the translated trice strings. |
|
id
Package id List is responsible for id List managing
|
Package id List is responsible for id List managing |
|
keybcmd
Package keybcmd is responsible for interpreting user commandline and executing commands
|
Package keybcmd is responsible for interpreting user commandline and executing commands |
|
link
Package link reads from SeggerRTT with the SEGGER app JLinkRTTLogger or with the open source app stRttLogger.exe.
|
Package link reads from SeggerRTT with the SEGGER app JLinkRTTLogger or with the open source app stRttLogger.exe. |
|
pkg
|
|
|
cipher
Package cipher provides an encryption and decryption interface.
|
Package cipher provides an encryption and decryption interface. |
|
endian
Package endian provides an architecture agnostic value describing the native endianness on the local machine.
|
Package endian provides an architecture agnostic value describing the native endianness on the local machine. |
|
msg
Package msg provides common message functions.
|
Package msg provides common message functions. |
|
tst
Package tst provides some helper functions for testing.
|
Package tst provides some helper functions for testing. |
|
test
|
|
|
doubleBuffer_deferred_multi_cobs
Package cgot is a helper for testing the target C-code.
|
Package cgot is a helper for testing the target C-code. |
|
doubleBuffer_deferred_multi_tcobs
Package cgot is a helper for testing the target C-code.
|
Package cgot is a helper for testing the target C-code. |
|
doubleBuffer_deferred_multi_xtea_cobs
Package cgot is a helper for testing the target C-code.
|
Package cgot is a helper for testing the target C-code. |
|
doubleBuffer_deferred_single_cobs
Package cgot is a helper for testing the target C-code.
|
Package cgot is a helper for testing the target C-code. |
|
doubleBuffer_deferred_single_tcobs
Package cgot is a helper for testing the target C-code.
|
Package cgot is a helper for testing the target C-code. |
|
doubleBuffer_direct_noRouting_nopf
Package cgot is a helper for testing the target C-code.
|
Package cgot is a helper for testing the target C-code. |
|
doubleBuffer_twin_direct_noRouting_nopf_deferred_multi_cobs
Package cgot is a helper for testing the target C-code.
|
Package cgot is a helper for testing the target C-code. |
|
ringBuffer_deferred_cobs
Package cgot is a helper for testing the target C-code.
|
Package cgot is a helper for testing the target C-code. |
|
ringBuffer_deferred_tcobs
Package cgot is a helper for testing the target C-code.
|
Package cgot is a helper for testing the target C-code. |
|
ringBuffer_deferred_xtea_cobs
Package cgot is a helper for testing the target C-code.
|
Package cgot is a helper for testing the target C-code. |
|
stackBuffer_cobs
Package cgot is a helper for testing the target C-code.
|
Package cgot is a helper for testing the target C-code. |
|
stackBuffer_nopf
Package cgot is a helper for testing the target C-code.
|
Package cgot is a helper for testing the target C-code. |
|
stackBuffer_tcobs
Package cgot is a helper for testing the target C-code.
|
Package cgot is a helper for testing the target C-code. |
|
staticBuffer_cobs
Package cgot is a helper for testing the target C-code.
|
Package cgot is a helper for testing the target C-code. |
|
staticBuffer_nopf
Package cgot is a helper for testing the target C-code.
|
Package cgot is a helper for testing the target C-code. |
|
staticBuffer_tcobs
Package cgot is a helper for testing the target C-code.
|
Package cgot is a helper for testing the target C-code. |
Click to show internal directories.
Click to hide internal directories.