Categorygithub.com/fs-world/logformat
modulepackage
0.5.0
Repository: https://github.com/fs-world/logformat.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
10
Dependents
0
Files
2.3k SLOC

# README

logformat

Go Reference gotest

This repository contains the log formats used in the FS World Datalogger used in Formula Student competitions.

Usage

go get github.com/fs-world/logformat

Modifying

The marshalling functions for the structs are autogenerated using msgp and easyjson.

To update the generated code follow these steps:

# Install msgp & easyjson
go install github.com/tinylib/msgp@latest
go install github.com/mailru/easyjson/...@latest
# run generators
go generate

# Functions

NewSerializedLogReader creates a new SerializedLogReader from the provided file for the provided dataType.
NewSerializedLogWriter creates a new LogWriter.

# Constants

No description provided by the author
BufferedMeasurementSizeIvt must be at least (BufferedMeasurementSize / 5) + 1.
BufferedMeasurementSizeIvt must be at least (BufferedMeasurementSize / 8) + 1.
CANFrameLength is total length of the frame in the kernel.

# Structs

CANFrame is a CAN frame.
No description provided by the author
IvtBufferedMeasurement is collection of multiple measurements from the IVT sensor.
SerializedLogReader is a reader for log files with Serializable messages.
SerializedLogWriter writes Serializable messages to a logfile and hashes the logfile in the background.
Timespec is the unix.Timespec struct with msgp tags.
Timespec64 is the unix.Timespec struct for newer 64-bit platforms with msgp tags.

# Interfaces

LogReader is an interface for log readers.
LogWriter is an interface for log writers.
Serializable is an interface that all data to be persisted as log data must satisfy.