protocol

Documentation

Index

• Constants
• type Packet
• type PacketReceiver
• type PacketTransmitter
• type StatsReceiver

Constants

const (
	ADSB       = "adsb"
	APRS       = "aprs"
	APRS_IS    = "aprsis"
	AX25       = "ax25"
	LoRa       = "lora"
	MeshCore   = "meshcore"
	Meshtastic = "meshtastic"
)

Protocol standard names (as used in this package).

Types

type Packet

type Packet struct {
	Time     time.Time `json:"time,omitempty"` // Receive time stamp
	Protocol string    `json:"protocol"`       // Protocol name
	Radio    string    `json:"radio"`          // Radio name/ID
	SNR      float64   `json:"snr"`            // Signal-to-noise Ratio
	RSSI     int       `json:"rssi"`           // Received Signal Strength Indicator
	Raw      []byte    `json:"raw"`            // Raw packet
}

Packet represents a raw packet.

type PacketReceiver

type PacketReceiver interface {
	radio.Device

	// RawPackets starts receiving raw packets.
	RawPackets() <-chan *Packet
}

Receiver of packets.

type PacketTransmitter

type PacketTransmitter interface {
	radio.Device

	// SendRawPacket sends a raw (encoded) packet.
	SendRawPacket(*Packet) error
}

type StatsReceiver

type StatsReceiver interface {
	// Stats returns a channel that receives stats updates.
	Stats() <-chan map[string]any
}