backend

Documentation

Index

• func GetTemperatureProbeReadings(params *temperatures.GetTemperaturesParams) ([]*models.TemperatureReading, error)
• func Health() (*models.Health, error)
• type AlertsManager
  • func NewAlertsManager() *AlertsManager
  • func (m *AlertsManager) ClearAlert(params *alerts.UpdateAlertParams) (bool, error)
• type MonitorsManager
  • func NewMonitorsManager() *MonitorsManager
  • func (m *MonitorsManager) UpdateMonitor(params *monitors.UpdateMonitorParams) (bool, error)

Functions

func GetTemperatureProbeReadings

func GetTemperatureProbeReadings(params *temperatures.GetTemperaturesParams) ([]*models.TemperatureReading, error)

GetTemperatureProbeReadings reads the current sensor values from the onboard temperature sensors

func Health

func Health() (*models.Health, error)

Health performs all internal health checks to ensure all systems are functioning

Types

type AlertsManager

type AlertsManager struct {
}

AlertsManager provides methods to operate on monitors within the backend database

func NewAlertsManager

func NewAlertsManager() *AlertsManager

NewAlertsManager creates a manager which can operate on temperature monitors

func (*AlertsManager) ClearAlert

func (m *AlertsManager) ClearAlert(params *alerts.UpdateAlertParams) (bool, error)

ClearAlert clears the warning alert from a probe

type MonitorsManager

type MonitorsManager struct {
}

MonitorsManager provides methods to operate on monitors within the backend database

func NewMonitorsManager

func NewMonitorsManager() *MonitorsManager

NewMonitorsManager creates a manager which can operate on temperature monitors

func (*MonitorsManager) UpdateMonitor

func (m *MonitorsManager) UpdateMonitor(params *monitors.UpdateMonitorParams) (bool, error)

UpdateMonitor updates the temperature monitor settings for a given probe