models

type Band struct {
	Start int
	End   int
}

type BandsDownUp struct {
	Downstream []Band
	Upstream   []Band
}

type Bins struct {
	Mode Mode

	Bands BandsDownUp

	// PilotTones contains the bin indexes of all pilot tones
	PilotTones []int

	// Bits is the number of bits modulated onto the subcarrier, valid range: 0 to 15
	Bits BinsBitsDownUp

	// SNR is the signal-to-noise ratio in dB, valid range: -32 to 95
	SNR BinsFloatDownUp

	// QLN is the level of noise present on the line without any xDSL signal in dBm/Hz, valid range: -150 to -23
	QLN BinsFloatDownUp

	// Hlog is the channel characteristic and estimates the attenuation in dB, valid range: -96.2 to 6
	Hlog BinsFloatDownUp
}

type BinsBits struct {
	Data []int8
}

type BinsBitsDownUp struct {
	Downstream BinsBits
	Upstream   BinsBits
}

type BinsFloat struct {
	// GroupSize specifies how many bins are grouped into a single value
	GroupSize int

	// Data contains the actual data, with multiple bins grouped
	Data []float64
}

type BinsFloatDownUp struct {
	Downstream BinsFloat
	Upstream   BinsFloat
}

type BinsFloatMinMax struct {
	GroupSize int

	Min []float64
	Max []float64
}

type BinsFloatMinMaxDownUp struct {
	Downstream BinsFloatMinMax
	Upstream   BinsFloatMinMax
}

type BinsHistory struct {
	SNR BinsFloatMinMaxDownUp
}

type BoolValue struct {
	Valid bool
	Bool  bool
}

type Duration struct {
	Valid    bool
	Duration time.Duration
}

type ErrorsHistory struct {
	EndTime      time.Time
	PeriodLength time.Duration
	PeriodCount  int

	Showtime []BoolValue

	DownstreamRTXTXCount []IntValue
	UpstreamRTXTXCount   []IntValue

	DownstreamRTXCCount []IntValue
	UpstreamRTXCCount   []IntValue

	DownstreamRTXUCCount []IntValue
	UpstreamRTXUCCount   []IntValue

	DownstreamFECCount []IntValue
	UpstreamFECCount   []IntValue

	DownstreamCRCCount []IntValue
	UpstreamCRCCount   []IntValue

	DownstreamESCount []IntValue
	UpstreamESCount   []IntValue

	DownstreamSESCount []IntValue
	UpstreamSESCount   []IntValue
}

type FloatValue struct {
	Valid bool
	Float float64
}

type IntValue struct {
	Valid bool
	Int   int64
}

type Inventory struct {
	Vendor  string
	Version string
}

type Mode struct {
	Type    ModeType
	Subtype ModeSubtype
}

type ModeSubtype int

type ModeType int

type OLRValue struct {
	Enabled  BoolValue
	Executed IntValue
}

type State int

type Status struct {
	State  State
	Mode   Mode
	Uptime Duration

	DownstreamActualRate ValueBandwidth
	UpstreamActualRate   ValueBandwidth

	DownstreamAttainableRate ValueBandwidth
	UpstreamAttainableRate   ValueBandwidth

	DownstreamMinimumErrorFreeThroughput ValueBandwidth
	UpstreamMinimumErrorFreeThroughput   ValueBandwidth

	DownstreamBitswap OLRValue
	UpstreamBitswap   OLRValue

	DownstreamSeamlessRateAdaptation OLRValue
	UpstreamSeamlessRateAdaptation   OLRValue

	DownstreamInterleavingDelay ValueMilliseconds
	UpstreamInterleavingDelay   ValueMilliseconds

	DownstreamImpulseNoiseProtection ValueSymbols
	UpstreamImpulseNoiseProtection   ValueSymbols

	DownstreamRetransmissionEnabled BoolValue
	UpstreamRetransmissionEnabled   BoolValue

	DownstreamVectoringState VectoringValue
	UpstreamVectoringState   VectoringValue

	DownstreamAttenuation ValueDecibel
	UpstreamAttenuation   ValueDecibel

	DownstreamSNRMargin ValueDecibel
	UpstreamSNRMargin   ValueDecibel

	DownstreamPower ValuePower
	UpstreamPower   ValuePower

	DownstreamRTXTXCount IntValue
	UpstreamRTXTXCount   IntValue

	DownstreamRTXCCount IntValue
	UpstreamRTXCCount   IntValue

	DownstreamRTXUCCount IntValue
	UpstreamRTXUCCount   IntValue

	DownstreamFECCount IntValue
	UpstreamFECCount   IntValue

	DownstreamCRCCount IntValue
	UpstreamCRCCount   IntValue

	DownstreamESCount IntValue
	UpstreamESCount   IntValue

	DownstreamSESCount IntValue
	UpstreamSESCount   IntValue

	FarEndInventory  Inventory
	NearEndInventory Inventory
}

type Value interface {
	String() string
	Value() string
	Unit() string
}

type ValueBandwidth struct {
	IntValue
}

type ValueDecibel struct {
	FloatValue
}

type ValueMilliseconds struct {
	FloatValue
}

type ValuePower struct {
	FloatValue
}

type ValueSymbols struct {
	FloatValue
}

type VectoringState int

type VectoringValue struct {
	Valid bool
	State VectoringState
}