fitcsv

Documentation

Overview

Package fitcsv provides the implementations of FIT listener's interfaces that can listen to the events emitted by the decoder. The received events then will be converted and written as csv as they arrive.

This package can be helpful for debuging the library to ensure that the data is being decoded correctly.

Index

• type CSVToFITConv
  • func NewCSVToFITConv(fitWriter io.Writer, csvReader io.Reader) *CSVToFITConv
  • func (c *CSVToFITConv) Convert() error
  • func (c *CSVToFITConv) ResultInfo() CSVToFITConvInfo
• type CSVToFITConvInfo
• type FITToCSVConv
  • func NewFITToCSVConv(w io.Writer, opts ...Option) *FITToCSVConv
  • func (c *FITToCSVConv) Err() error
  • func (c *FITToCSVConv) OnMesg(mesg proto.Message)
  • func (c *FITToCSVConv) OnMesgDef(mesgDef proto.MessageDefinition)
  • func (c *FITToCSVConv) Wait()
• type Option
  • func WithChannelBufferSize(size int) Option
  • func WithPrintGPSPositionInDegrees() Option
  • func WithPrintOnlyValidValue() Option
  • func WithPrintRawValue() Option
  • func WithPrintUnknownMesgNum() Option
  • func WithTrimTrailingCommas() Option
  • func WithUseDisk(writeBuffer int) Option

Types

type CSVToFITConv

type CSVToFITConv struct {
	// contains filtered or unexported fields
}

func NewCSVToFITConv

func NewCSVToFITConv(fitWriter io.Writer, csvReader io.Reader) *CSVToFITConv

NewCSVToFITConv creates a new CSV to FIT converter.

func (*CSVToFITConv) Convert

func (c *CSVToFITConv) Convert() error

func (*CSVToFITConv) ResultInfo

func (c *CSVToFITConv) ResultInfo() CSVToFITConvInfo

type CSVToFITConvInfo

type CSVToFITConvInfo struct {
	UnknownMesg         int
	UnknownField        int
	UnknownDynamicField int
	Sequence            int
}

type FITToCSVConv

type FITToCSVConv struct {
	// contains filtered or unexported fields
}

FITToCSVConv is an implementation for listeners that receive message events and convert them into CSV records.

func NewFITToCSVConv

func NewFITToCSVConv(w io.Writer, opts ...Option) *FITToCSVConv

NewFITToCSVConv creates a new FIT to CSV converter. The caller must call Wait() to wait all events are received and finalizing the convert process.

func (*FITToCSVConv) Err

func (c *FITToCSVConv) Err() error

Err returns any error that occur during processing events.

func (*FITToCSVConv) OnMesg

func (c *FITToCSVConv) OnMesg(mesg proto.Message)

OnMesgDef receive message from broadcaster

func (*FITToCSVConv) OnMesgDef

func (c *FITToCSVConv) OnMesgDef(mesgDef proto.MessageDefinition)

OnMesgDef receive message definition from broadcaster

func (*FITToCSVConv) Wait

func (c *FITToCSVConv) Wait()

Wait closes the buffered channel and wait until all event handling is completed and finalize the data.

type Option

type Option func(o *options)

Option is FITToCSVConv's option.

func WithChannelBufferSize

func WithChannelBufferSize(size int) Option

func WithPrintGPSPositionInDegrees

func WithPrintGPSPositionInDegrees() Option

func WithPrintOnlyValidValue

func WithPrintOnlyValidValue() Option

func WithPrintRawValue

func WithPrintRawValue() Option

func WithPrintUnknownMesgNum

func WithPrintUnknownMesgNum() Option

func WithTrimTrailingCommas

func WithTrimTrailingCommas() Option

func WithUseDisk

func WithUseDisk(writeBuffer int) Option