api

Documentation

Index

• Constants
• type Error
• type Event
• type Message
  • func NewMessage(msgType string, data interface{}) (Message, error)
• type Station
  • func NewStation(station *wifi.StationInfo) Station
  • func NewStations(stations []*wifi.StationInfo) []Station

Constants

const (
	// commands used by the protocol
	CmdDump = "dump"
	CmdGet  = "get"

	// station event actions
	ActionConnect    = "connect"
	ActionDisconnect = "disconnect"

	// message types
	TypeError           = "error"
	TypeStationEvent    = "station-event"
	TypeCmdGetResponse  = CmdGet + "-response"
	TypeCmdDumpResponse = CmdDump + "-response"
)

Types

type Error

type Error struct {
	Message string `json:"message"`
	Error   string `json:"error"`
}

type Event

type Event struct {
	Action  string  `json:"action"`
	Station Station `json:"station"`
}

Event represents when a station connects or disconnects

type Message

type Message struct {
	Type string          `json:"type"`
	Data json.RawMessage `json:"data"`
}

Message is the generic wrapper for messages

func NewMessage

func NewMessage(msgType string, data interface{}) (Message, error)

type Station

type Station struct {
	Wifi wifi.StationInfo `json:"wifi"`
	IP   net.IP           `json:"ip"`
}

Station is a wifi station info and IP address

func NewStation

func NewStation(station *wifi.StationInfo) Station

NewStation returns a station given the station info

func NewStations

func NewStations(stations []*wifi.StationInfo) []Station

NewStations returns stations given the station infos