README.md

Trice <- TRace Ids C Embedded

github.io/trice/

"log in (a) trice" (S>G)

About

• Replace printf or log in C-code code for getting:
  • SPEED, to be usable also inside interrupts,
  • SPACE, to reduce needed FLASH memory size,
  • and various FEATURES delighting the developers heart.
• 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:
  1. C code TRICE macros generating tiny & super fast embedded device real-time trace/log code
  2. 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 packges, exchange the carried IDs with the format string and print out.
• Trice Usage guide

Possible Use Cases

• Using Trice not only for dynamic 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.
  • Optionally add til.json as a (compressed) resource to your target image. One possibility is using SRecord.
• 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 TRICE occupies only about 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

• Inplemented:
  • UART conectable to virtual UART over USB
  • RTT over J-Link and RTT over ST-Link
• A small separate micro controller is always usable as bridge to interfaces like: GPIO, I²C, SPI, CAN, LIN, ...

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 - is 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

• NanoLog (Linux C++)
• baical.net (C)
• defmt (Rust)