api

Documentation

Overview

Package api defines the types for frontend-backend communication

Index

• type Direction
• type Mode
• type PortInfo
• type Record
• type State
• type Stats

Types

type Direction

type Direction string

Direction represents data direction

const (
	TX Direction = "TX"
	RX Direction = "RX"
)

type Mode

type Mode string

Mode represents application mode

const (
	ModeIdle    Mode = ""
	ModeRecord  Mode = "record"
	ModeCompare Mode = "compare"
)

type PortInfo

type PortInfo struct {
	PortPath string `json:"portPath"` // "/dev/ttys000"
	PortType string `json:"portType"` // "virtual", "physical"
}

PortInfo represents a serial port

type Record

type Record struct {
	Index int    `json:"index"`
	Dir   string `json:"dir"`  // "TX", "RX"
	Data  string `json:"data"` // hex encoded
	Size  int    `json:"size"`
	Match *bool  `json:"match,omitempty"` // only for actual
}

Record represents a data record

type State

type State struct {
	Mode       string     `json:"mode"` // "", "record", "compare"
	UpperPort  string     `json:"upperPort"`
	LowerPorts []PortInfo `json:"lowerPorts"`
	Baseline   []Record   `json:"baseline"`
	Actual     []Record   `json:"actual"`
	Stats      Stats      `json:"stats"`
}

State represents the complete application state

type Stats

type Stats struct {
	TX      int `json:"tx"`
	RX      int `json:"rx"`
	Matched int `json:"matched"`
	Diff    int `json:"diff"`
}

Stats represents statistics