api

Documentation

Index

• Variables
• func GetActivityInRange(rw http.ResponseWriter, req *http.Request)
• func GetAllActivity(rw http.ResponseWriter, req *http.Request)
• func ShowUI(rw http.ResponseWriter, req *http.Request)
• type ActivityRequest
• type ConfigAPI
  • func (c *ConfigAPI) GetAllConfig(rw http.ResponseWriter, req *http.Request)
  • func (c *ConfigAPI) GetConfigItem(rw http.ResponseWriter, req *http.Request)
  • func (c *ConfigAPI) RemoveConfigItem(rw http.ResponseWriter, req *http.Request)
  • func (c *ConfigAPI) SetAllConfigItems(rw http.ResponseWriter, req *http.Request)
  • func (c *ConfigAPI) SetConfigItem(rw http.ResponseWriter, req *http.Request)
• type CurrentState
• type ErrorResponse
• type Hub
  • func NewHub() *Hub
• type SystemAPI
  • func (s *SystemAPI) GetCurrentState(rw http.ResponseWriter, req *http.Request)
  • func (s *SystemAPI) UpdateWifi(rw http.ResponseWriter, req *http.Request)
• type WifiUpdateRequest
• type WifiUpdateResponse
• type WsHandler
  • func (wsh WsHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)

Variables

var (
	// BuildVersion contains the version information for the app
	BuildVersion = "Unknown"

	// CommitID is the git commitId for the app.  It's filled in as
	// part of the automated build
	CommitID string

	// ApplicationStartTime is the start time of the app
	ApplicationStartTime = time.Now()
)

Functions

func GetActivityInRange

func GetActivityInRange(rw http.ResponseWriter, req *http.Request)

GetActivityInRange gets activity for the appliance for a given time range

func GetAllActivity

func GetAllActivity(rw http.ResponseWriter, req *http.Request)

GetAllActivity gets activity for the appliance for a given time range

func ShowUI

func ShowUI(rw http.ResponseWriter, req *http.Request)

ShowUI redirects to the /ui/ url path

Types

type ActivityRequest

type ActivityRequest struct {
	StartTime string `json:"starttime"`
	EndTime   string `json:"endtime"`
}

ActivityRequest represents an API request for activity

type ConfigAPI

type ConfigAPI struct {

	// Updated signals when the configuration has been updated
	Updated chan bool
}

ConfigAPI represents the configuration API routes

func (*ConfigAPI) GetAllConfig

func (c *ConfigAPI) GetAllConfig(rw http.ResponseWriter, req *http.Request)

GetAllConfig gets all configuration and returns it in JSON format.

func (*ConfigAPI) GetConfigItem

func (c *ConfigAPI) GetConfigItem(rw http.ResponseWriter, req *http.Request)

GetConfigItem gets a single configuration and returns it in JSON format. If the item can't be found, returns an empty config item

func (*ConfigAPI) RemoveConfigItem

func (c *ConfigAPI) RemoveConfigItem(rw http.ResponseWriter, req *http.Request)

RemoveConfigItem removes a single config item

func (*ConfigAPI) SetAllConfigItems

func (c *ConfigAPI) SetAllConfigItems(rw http.ResponseWriter, req *http.Request)

SetAllConfigItems adds or updates multiple config items and returns all config items in JSON format

func (*ConfigAPI) SetConfigItem

func (c *ConfigAPI) SetConfigItem(rw http.ResponseWriter, req *http.Request)

SetConfigItem adds or updates a single config item and returns the new item in JSON format

type CurrentState

type CurrentState struct {
	ServerStartTime    time.Time `json:"starttime"`
	ApplicationVersion string    `json:"appversion"`
	DeviceRunning      bool      `json:"devicerunning"`
	DeviceID           string    `json:"deviceId"`
}

CurrentState describes the current running state of the application

type ErrorResponse

type ErrorResponse struct {
	Status  int    `json:"status"`
	Message string `json:"message"`
}

ErrorResponse represents an API response

type Hub

type Hub struct {

	// Inbound messages from the connections.
	Broadcast chan []byte
	// contains filtered or unexported fields
}

Hub is used to manage and coordinate websocket connections

func NewHub

func NewHub() *Hub

NewHub creates a new hub object

type SystemAPI

type SystemAPI struct {
	// Reboot signals when the machine should be rebooted
	Reboot chan bool
}

SystemAPI represents the system API routes

func (*SystemAPI) GetCurrentState

func (s *SystemAPI) GetCurrentState(rw http.ResponseWriter, req *http.Request)

GetCurrentState gets the current running state of the application

func (*SystemAPI) UpdateWifi

func (s *SystemAPI) UpdateWifi(rw http.ResponseWriter, req *http.Request)

UpdateWifi updates the wifi credentials for the machine

type WifiUpdateRequest

type WifiUpdateRequest struct {
	SSID       string `json:"ssid"`
	Passphrase string `json:"passphrase"`
}

WifiUpdateRequest describes the request to update the Wifi credentials

type WifiUpdateResponse

type WifiUpdateResponse struct {
	Status      int    `json:"status"`
	Description string `json:"description"`
}

WifiUpdateResponse describes the response to update the Wifi credentials

type WsHandler

type WsHandler struct {
	H *Hub
}

func (WsHandler) ServeHTTP

func (wsh WsHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)