api

Documentation

Index

• type API
  • func NewAPI(l *slog.Logger, address string, apiKey string) *API
  • func (s *API) Address() string
  • func (s *API) Events(types []events.EventType) *EventSource
  • func (s *API) GetConfig() (*stconfig.Configuration, error)
  • func (s *API) GetDeviceStats() (map[protocol.DeviceID]DeviceStatistics, error)
  • func (s *API) GetSystemStatus() (*SystemStatus, error)
  • func (s *API) GetSystemVersion() (*SystemVersion, error)
  • func (s *API) RemoveDevice(deviceID protocol.DeviceID) error
  • func (s *API) RemoveFolder(folderID string) error
  • func (s *API) SetDevice(cfg *stconfig.DeviceConfiguration) error
  • func (s *API) SetFolder(cfg *stconfig.FolderConfiguration) error
  • func (s *API) String() string
• type DeviceStatistics
• type EventSource
  • func (s *EventSource) Events(ctx context.Context) ([]events.Event, error)
• type SystemStatus
• type SystemVersion

Types

type API

type API struct {
	suture.Service
	// contains filtered or unexported fields
}

func NewAPI

func NewAPI(l *slog.Logger, address string, apiKey string) *API

func (*API) Address

func (s *API) Address() string

func (*API) Events

func (s *API) Events(types []events.EventType) *EventSource

func (*API) GetConfig

func (s *API) GetConfig() (*stconfig.Configuration, error)

func (*API) GetDeviceStats

func (s *API) GetDeviceStats() (map[protocol.DeviceID]DeviceStatistics, error)

func (*API) GetSystemStatus

func (s *API) GetSystemStatus() (*SystemStatus, error)

func (*API) GetSystemVersion

func (s *API) GetSystemVersion() (*SystemVersion, error)

func (*API) RemoveDevice

func (s *API) RemoveDevice(deviceID protocol.DeviceID) error

func (*API) RemoveFolder

func (s *API) RemoveFolder(folderID string) error

func (*API) SetDevice

func (s *API) SetDevice(cfg *stconfig.DeviceConfiguration) error

func (*API) SetFolder

func (s *API) SetFolder(cfg *stconfig.FolderConfiguration) error

func (*API) String

func (s *API) String() string

type DeviceStatistics

type DeviceStatistics struct {
	LastSeen               time.Time
	LastConnectionDuration float64 // seconds
}

type EventSource

type EventSource struct {
	// contains filtered or unexported fields
}

func (*EventSource) Events

func (s *EventSource) Events(ctx context.Context) ([]events.Event, error)

type SystemStatus

type SystemStatus struct {
	MyID protocol.DeviceID `json:"myID"`
}

type SystemVersion

type SystemVersion struct {
	Version string
	OS      string
	Arch    string
}