Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Color ¶
type Color struct {
// Color in hex representation
// Required: true
Hex *string `json:"hex"`
}
Color color swagger:model Color
type Error ¶
type Error struct {
// Internal error code. In generic error cases this may be a HTTP status code.
// Therefore internal error codes should not conflict with HTTP status codes.
//
// Required: true
Code *int32 `json:"code"`
// Optional list of field names which caused the error
Fields string `json:"fields,omitempty"`
// A brief description of the error
Message string `json:"message,omitempty"`
}
Error error swagger:model Error
type HardwareConfig ¶
type HardwareConfig struct {
// analog max
// Required: true
// Minimum: 0
AnalogMax *int32 `json:"analogMax"`
// The amount the voltage will increase to reflect a unit increase in analog reading
// Minimum: 0
AnalogVoltsPerUnit *float32 `json:"analogVoltsPerUnit,omitempty"`
// num led pixels
// Required: true
// Minimum: 0
NumLedPixels *int32 `json:"numLedPixels"`
// probes
// Required: true
Probes []*TemperatureProbe `json:"probes"`
// vcc
// Required: true
Vcc *float32 `json:"vcc"`
}
HardwareConfig hardware config swagger:model HardwareConfig
type Health ¶
type Health struct {
// error
Error *Error `json:"error,omitempty"`
// Flag indicating whether or not ALL internal checks passed
// Required: true
Healthy *bool `json:"healthy"`
// service info
// Required: true
ServiceInfo *ServiceInfo `json:"service_info"`
}
Health health swagger:model Health
type LightStrip ¶
type LightStrip struct {
// The time interval between updates in microseconds
// Required: true
// Minimum: 0
Interval *int32 `json:"interval"`
// Name of the light strip
// Required: true
Name *string `json:"name"`
// pixels
// Required: true
Pixels []*Color `json:"pixels"`
}
LightStrip light strip swagger:model LightStrip
type ServiceInfo ¶
type ServiceInfo struct {
// Service name
// Required: true
Name *string `json:"name"`
// Service API version
// Required: true
Version *string `json:"version"`
}
ServiceInfo service info swagger:model ServiceInfo
type Shutdown ¶
type Shutdown struct {
// message
// Required: true
Message *string `json:"Message"`
// shutdown time
// Required: true
ShutdownTime *string `json:"ShutdownTime"`
}
Shutdown shutdown swagger:model Shutdown
type TemperatureLimits ¶
type TemperatureLimits struct {
// max abs celsius
// Required: true
MaxAbsCelsius *int32 `json:"maxAbsCelsius"`
// max warn celsius
// Required: true
MaxWarnCelsius *int32 `json:"maxWarnCelsius"`
// min abs celsius
// Required: true
MinAbsCelsius *int32 `json:"minAbsCelsius"`
// min warn celsius
// Required: true
MinWarnCelsius *int32 `json:"minWarnCelsius"`
// Ambient probes measure air temperature. Cooking probes measure food temperature
// Required: true
ProbeType *string `json:"probeType"`
}
TemperatureLimits temperature limits swagger:model TemperatureLimits
type TemperatureProbe ¶
type TemperatureProbe struct {
// enabled
// Required: true
Enabled *bool `json:"enabled"`
// label
// Required: true
Label *string `json:"label"`
// limits
// Required: true
Limits *TemperatureLimits `json:"limits"`
}
TemperatureProbe temperature probe swagger:model TemperatureProbe
type TemperatureReading ¶
type TemperatureReading struct {
// analog
// Required: true
// Maximum: 1023
// Minimum: 0
Analog *int32 `json:"analog"`
// Temperature reading in degrees Celsius
// Required: true
Celsius *int32 `json:"celsius"`
// Temperature reading in degrees Fahrenheit
// Required: true
Fahrenheit *int32 `json:"fahrenheit"`
// Temperature reading in degrees Kelvin
// Required: true
Kelvin *int32 `json:"kelvin"`
// probe
// Required: true
// Maximum: 3
// Minimum: 0
Probe *int32 `json:"probe"`
// The date and time of the reading
// Required: true
Updated *strfmt.DateTime `json:"updated"`
// voltage
// Required: true
// Maximum: 3.3
// Minimum: 0
Voltage *float32 `json:"voltage"`
// warning
Warning string `json:"warning,omitempty"`
// warning ackd
// Required: true
WarningAckd bool `json:"warning_ackd"`
}
TemperatureReading temperature reading swagger:model TemperatureReading
Click to show internal directories.
Click to hide internal directories.