Documentation
¶
Overview ¶
THIS FILE IS AUTO-GENERATED
THIS FILE IS AUTO-GENERATED ¶
THIS FILE IS AUTO-GENERATED ¶
THIS FILE IS AUTO-GENERATED ¶
THIS FILE IS AUTO-GENERATED ¶
THIS FILE IS AUTO-GENERATED ¶
THIS FILE IS AUTO-GENERATED ¶
THIS FILE IS AUTO-GENERATED ¶
THIS FILE IS AUTO-GENERATED ¶
THIS FILE IS AUTO-GENERATED ¶
THIS FILE IS AUTO-GENERATED ¶
THIS FILE IS AUTO-GENERATED ¶
Package service implements the HomeKit services.
THIS FILE IS AUTO-GENERATED ¶
THIS FILE IS AUTO-GENERATED ¶
THIS FILE IS AUTO-GENERATED ¶
THIS FILE IS AUTO-GENERATED ¶
THIS FILE IS AUTO-GENERATED ¶
THIS FILE IS AUTO-GENERATED ¶
THIS FILE IS AUTO-GENERATED ¶
THIS FILE IS AUTO-GENERATED ¶
THIS FILE IS AUTO-GENERATED ¶
THIS FILE IS AUTO-GENERATED ¶
THIS FILE IS AUTO-GENERATED ¶
THIS FILE IS AUTO-GENERATED ¶
THIS FILE IS AUTO-GENERATED ¶
THIS FILE IS AUTO-GENERATED ¶
THIS FILE IS AUTO-GENERATED ¶
THIS FILE IS AUTO-GENERATED ¶
THIS FILE IS AUTO-GENERATED ¶
THIS FILE IS AUTO-GENERATED ¶
THIS FILE IS AUTO-GENERATED ¶
THIS FILE IS AUTO-GENERATED ¶
THIS FILE IS AUTO-GENERATED ¶
THIS FILE IS AUTO-GENERATED ¶
THIS FILE IS AUTO-GENERATED ¶
THIS FILE IS AUTO-GENERATED ¶
THIS FILE IS AUTO-GENERATED ¶
THIS FILE IS AUTO-GENERATED ¶
THIS FILE IS AUTO-GENERATED ¶
THIS FILE IS AUTO-GENERATED ¶
THIS FILE IS AUTO-GENERATED ¶
THIS FILE IS AUTO-GENERATED ¶
THIS FILE IS AUTO-GENERATED ¶
THIS FILE IS AUTO-GENERATED ¶
THIS FILE IS AUTO-GENERATED ¶
THIS FILE IS AUTO-GENERATED ¶
THIS FILE IS AUTO-GENERATED ¶
THIS FILE IS AUTO-GENERATED ¶
THIS FILE IS AUTO-GENERATED
Index ¶
- Constants
- type AccessoryInformation
- type AirPurifier
- type AirQualitySensor
- type BatteryService
- type BridgeConfiguration
- type BridgingState
- type CameraControl
- type CameraRTPStreamManagement
- type CameraRecordingManagement
- type CarbonDioxideSensor
- type CarbonMonoxideSensor
- type ColoredLightbulb
- type ContactSensor
- type Cooler
- type Door
- type Doorbell
- type Fan
- type FanV2
- type Faucet
- type FilterMaintenance
- type GarageDoorOpener
- type Heater
- type HeaterCooler
- type HumidifierDehumidifier
- type HumiditySensor
- type InputSource
- type IrrigationSystem
- type LeakSensor
- type LightSensor
- type Lightbulb
- type LockManagement
- type LockMechanism
- type Microphone
- type MotionSensor
- type OccupancySensor
- type Outlet
- type SecuritySystem
- type Service
- type ServiceLabel
- type ServiceType
- type Slat
- type SmokeSensor
- type Speaker
- type StatefulProgrammableSwitch
- type StatelessProgrammableSwitch
- type Switch
- type Television
- type TemperatureSensor
- type Thermostat
- type TimeInformation
- type TunneledBTLEAccessoryService
- type Valve
- type WifiTransport
- type Window
- type WindowCovering
Constants ¶
View Source
const TypeAccessoryInformation = "3E"
View Source
const TypeAirPurifier = "BB"
View Source
const TypeAirQualitySensor = "8D"
View Source
const TypeBatteryService = "96"
View Source
const TypeBridgeConfiguration = "A1"
View Source
const TypeBridgingState = "62"
View Source
const TypeCameraControl = "111"
View Source
const TypeCameraRTPStreamManagement = "110"
View Source
const TypeCameraRecordingManagement = "204"
View Source
const TypeCarbonDioxideSensor = "97"
View Source
const TypeCarbonMonoxideSensor = "7F"
View Source
const TypeContactSensor = "80"
View Source
const TypeDoor = "81"
View Source
const TypeDoorbell = "121"
View Source
const TypeFan = "40"
View Source
const TypeFanV2 = "B7"
View Source
const TypeFaucet = "D7"
View Source
const TypeFilterMaintenance = "BA"
View Source
const TypeGarageDoorOpener = "41"
View Source
const TypeHeaterCooler = "BC"
View Source
const TypeHumidifierDehumidifier = "BD"
View Source
const TypeHumiditySensor = "82"
View Source
const TypeInputSource = "D9"
View Source
const TypeIrrigationSystem = "CF"
View Source
const TypeLeakSensor = "83"
View Source
const TypeLightSensor = "84"
View Source
const TypeLightbulb = "43"
View Source
const TypeLockManagement = "44"
View Source
const TypeLockMechanism = "45"
View Source
const TypeMicrophone = "112"
View Source
const TypeMotionSensor = "85"
View Source
const TypeOccupancySensor = "86"
View Source
const TypeOutlet = "47"
View Source
const TypeSecuritySystem = "7E"
View Source
const TypeServiceLabel = "CC"
View Source
const TypeSlat = "B9"
View Source
const TypeSmokeSensor = "87"
View Source
const TypeSpeaker = "113"
View Source
const TypeStatefulProgrammableSwitch = "88"
View Source
const TypeStatelessProgrammableSwitch = "89"
View Source
const TypeSwitch = "49"
View Source
const TypeTelevision = "D8"
View Source
const TypeTemperatureSensor = "8A"
View Source
const TypeThermostat = "4A"
View Source
const TypeTimeInformation = "99"
View Source
const TypeTunneledBTLEAccessoryService = "56"
View Source
const TypeValve = "D0"
View Source
const TypeWifiTransport = "22A"
View Source
const TypeWindow = "8B"
View Source
const TypeWindowCovering = "8C"
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AccessoryInformation ¶
type AccessoryInformation struct {
*Service
Identify *characteristic.Identify
Manufacturer *characteristic.Manufacturer
Model *characteristic.Model
Name *characteristic.Name
SerialNumber *characteristic.SerialNumber
FirmwareRevision *characteristic.FirmwareRevision
}
func NewAccessoryInformation ¶
func NewAccessoryInformation() *AccessoryInformation
type AirPurifier ¶
type AirPurifier struct {
*Service
Active *characteristic.Active
CurrentAirPurifierState *characteristic.CurrentAirPurifierState
TargetAirPurifierState *characteristic.TargetAirPurifierState
}
func NewAirPurifier ¶
func NewAirPurifier() *AirPurifier
type AirQualitySensor ¶
type AirQualitySensor struct {
*Service
AirQuality *characteristic.AirQuality
}
func NewAirQualitySensor ¶
func NewAirQualitySensor() *AirQualitySensor
type BatteryService ¶
type BatteryService struct {
*Service
BatteryLevel *characteristic.BatteryLevel
ChargingState *characteristic.ChargingState
StatusLowBattery *characteristic.StatusLowBattery
}
func NewBatteryService ¶
func NewBatteryService() *BatteryService
type BridgeConfiguration ¶
type BridgeConfiguration struct {
*Service
ConfigureBridgedAccessoryStatus *characteristic.ConfigureBridgedAccessoryStatus
DiscoverBridgedAccessories *characteristic.DiscoverBridgedAccessories
DiscoveredBridgedAccessories *characteristic.DiscoveredBridgedAccessories
ConfigureBridgedAccessory *characteristic.ConfigureBridgedAccessory
}
func NewBridgeConfiguration ¶
func NewBridgeConfiguration() *BridgeConfiguration
type BridgingState ¶
type BridgingState struct {
*Service
Reachable *characteristic.Reachable
LinkQuality *characteristic.LinkQuality
AccessoryIdentifier *characteristic.AccessoryIdentifier
Category *characteristic.Category
}
func NewBridgingState ¶
func NewBridgingState() *BridgingState
type CameraControl ¶
type CameraControl struct {
*Service
On *characteristic.On
}
func NewCameraControl ¶
func NewCameraControl() *CameraControl
type CameraRTPStreamManagement ¶
type CameraRTPStreamManagement struct {
*Service
SupportedVideoStreamConfiguration *characteristic.SupportedVideoStreamConfiguration
SupportedAudioStreamConfiguration *characteristic.SupportedAudioStreamConfiguration
SupportedRTPConfiguration *characteristic.SupportedRTPConfiguration
SelectedRTPStreamConfiguration *characteristic.SelectedRTPStreamConfiguration
StreamingStatus *characteristic.StreamingStatus
SetupEndpoints *characteristic.SetupEndpoints
}
func NewCameraRTPStreamManagement ¶
func NewCameraRTPStreamManagement() *CameraRTPStreamManagement
type CameraRecordingManagement ¶ added in v1.2.0
type CameraRecordingManagement struct {
*Service
SupportedCameraRecordingConfiguration *characteristic.SupportedCameraRecordingConfiguration
SupportedVideoRecordingConfiguration *characteristic.SupportedVideoRecordingConfiguration
SupportedAudioRecordingConfiguration *characteristic.SupportedAudioRecordingConfiguration
SelectedCameraRecordingConfiguration *characteristic.SelectedCameraRecordingConfiguration
}
func NewCameraRecordingManagement ¶ added in v1.2.0
func NewCameraRecordingManagement() *CameraRecordingManagement
type CarbonDioxideSensor ¶
type CarbonDioxideSensor struct {
*Service
CarbonDioxideDetected *characteristic.CarbonDioxideDetected
}
func NewCarbonDioxideSensor ¶
func NewCarbonDioxideSensor() *CarbonDioxideSensor
type CarbonMonoxideSensor ¶
type CarbonMonoxideSensor struct {
*Service
CarbonMonoxideDetected *characteristic.CarbonMonoxideDetected
}
func NewCarbonMonoxideSensor ¶
func NewCarbonMonoxideSensor() *CarbonMonoxideSensor
type ColoredLightbulb ¶ added in v1.2.1
type ColoredLightbulb struct {
*Service
On *characteristic.On
Brightness *characteristic.Brightness
Saturation *characteristic.Saturation
Hue *characteristic.Hue
}
func NewColoredLightbulb ¶ added in v1.2.1
func NewColoredLightbulb() *ColoredLightbulb
type ContactSensor ¶
type ContactSensor struct {
*Service
ContactSensorState *characteristic.ContactSensorState
}
func NewContactSensor ¶
func NewContactSensor() *ContactSensor
type Cooler ¶ added in v1.2.1
type Cooler struct {
*HeaterCooler
CoolingThresholdTemperature *characteristic.CoolingThresholdTemperature
}
type Door ¶
type Door struct {
*Service
CurrentPosition *characteristic.CurrentPosition
PositionState *characteristic.PositionState
TargetPosition *characteristic.TargetPosition
}
type Doorbell ¶
type Doorbell struct {
*Service
ProgrammableSwitchEvent *characteristic.ProgrammableSwitchEvent
}
func NewDoorbell ¶
func NewDoorbell() *Doorbell
type FanV2 ¶
type FanV2 struct {
*Service
Active *characteristic.Active
}
type Faucet ¶
type Faucet struct {
*Service
Active *characteristic.Active
}
type FilterMaintenance ¶
type FilterMaintenance struct {
*Service
FilterChangeIndication *characteristic.FilterChangeIndication
}
func NewFilterMaintenance ¶
func NewFilterMaintenance() *FilterMaintenance
type GarageDoorOpener ¶
type GarageDoorOpener struct {
*Service
CurrentDoorState *characteristic.CurrentDoorState
TargetDoorState *characteristic.TargetDoorState
ObstructionDetected *characteristic.ObstructionDetected
}
func NewGarageDoorOpener ¶
func NewGarageDoorOpener() *GarageDoorOpener
type Heater ¶ added in v1.2.1
type Heater struct {
*HeaterCooler
HeatingThresholdTemperature *characteristic.HeatingThresholdTemperature
}
type HeaterCooler ¶
type HeaterCooler struct {
*Service
Active *characteristic.Active
CurrentHeaterCoolerState *characteristic.CurrentHeaterCoolerState
TargetHeaterCoolerState *characteristic.TargetHeaterCoolerState
CurrentTemperature *characteristic.CurrentTemperature
}
func NewHeaterCooler ¶
func NewHeaterCooler() *HeaterCooler
type HumidifierDehumidifier ¶
type HumidifierDehumidifier struct {
*Service
CurrentRelativeHumidity *characteristic.CurrentRelativeHumidity
CurrentHumidifierDehumidifierState *characteristic.CurrentHumidifierDehumidifierState
TargetHumidifierDehumidifierState *characteristic.TargetHumidifierDehumidifierState
Active *characteristic.Active
}
func NewHumidifierDehumidifier ¶
func NewHumidifierDehumidifier() *HumidifierDehumidifier
type HumiditySensor ¶
type HumiditySensor struct {
*Service
CurrentRelativeHumidity *characteristic.CurrentRelativeHumidity
}
func NewHumiditySensor ¶
func NewHumiditySensor() *HumiditySensor
type InputSource ¶
type InputSource struct {
*Service
ConfiguredName *characteristic.ConfiguredName
InputSourceType *characteristic.InputSourceType
IsConfigured *characteristic.IsConfigured
CurrentVisibilityState *characteristic.CurrentVisibilityState
Identifier *characteristic.Identifier
InputDeviceType *characteristic.InputDeviceType
TargetVisibilityState *characteristic.TargetVisibilityState
Name *characteristic.Name
}
func NewInputSource ¶
func NewInputSource() *InputSource
type IrrigationSystem ¶
type IrrigationSystem struct {
*Service
Active *characteristic.Active
ProgramMode *characteristic.ProgramMode
InUse *characteristic.InUse
}
func NewIrrigationSystem ¶
func NewIrrigationSystem() *IrrigationSystem
type LeakSensor ¶
type LeakSensor struct {
*Service
LeakDetected *characteristic.LeakDetected
}
func NewLeakSensor ¶
func NewLeakSensor() *LeakSensor
type LightSensor ¶
type LightSensor struct {
*Service
CurrentAmbientLightLevel *characteristic.CurrentAmbientLightLevel
}
func NewLightSensor ¶
func NewLightSensor() *LightSensor
type Lightbulb ¶
type Lightbulb struct {
*Service
On *characteristic.On
}
func NewLightbulb ¶
func NewLightbulb() *Lightbulb
type LockManagement ¶
type LockManagement struct {
*Service
LockControlPoint *characteristic.LockControlPoint
Version *characteristic.Version
}
func NewLockManagement ¶
func NewLockManagement() *LockManagement
type LockMechanism ¶
type LockMechanism struct {
*Service
LockCurrentState *characteristic.LockCurrentState
LockTargetState *characteristic.LockTargetState
}
func NewLockMechanism ¶
func NewLockMechanism() *LockMechanism
type Microphone ¶
type Microphone struct {
*Service
Volume *characteristic.Volume
Mute *characteristic.Mute
}
func NewMicrophone ¶
func NewMicrophone() *Microphone
type MotionSensor ¶
type MotionSensor struct {
*Service
MotionDetected *characteristic.MotionDetected
}
func NewMotionSensor ¶
func NewMotionSensor() *MotionSensor
type OccupancySensor ¶
type OccupancySensor struct {
*Service
OccupancyDetected *characteristic.OccupancyDetected
}
func NewOccupancySensor ¶
func NewOccupancySensor() *OccupancySensor
type Outlet ¶
type Outlet struct {
*Service
On *characteristic.On
OutletInUse *characteristic.OutletInUse
}
type SecuritySystem ¶
type SecuritySystem struct {
*Service
SecuritySystemCurrentState *characteristic.SecuritySystemCurrentState
SecuritySystemTargetState *characteristic.SecuritySystemTargetState
}
func NewSecuritySystem ¶
func NewSecuritySystem() *SecuritySystem
type Service ¶
type Service struct {
ID uint64
Type string
Characteristics []*characteristic.Characteristic
Hidden bool
Primary bool
Linked []*Service
}
Service is an HomeKit service consisting of characteristics.
func (*Service) AddCharacteristic ¶
func (s *Service) AddCharacteristic(c *characteristic.Characteristic)
func (*Service) AddLinkedService ¶
func (*Service) Equal ¶
Equal returns true when receiver has the same characteristics, service id and service type as the argument.
func (*Service) GetCharacteristics ¶
func (s *Service) GetCharacteristics() []*characteristic.Characteristic
GetCharacteristics returns the characteristics which represent the service.
func (*Service) MarshalJSON ¶ added in v1.2.1
type ServiceLabel ¶
type ServiceLabel struct {
*Service
ServiceLabelNamespace *characteristic.ServiceLabelNamespace
}
func NewServiceLabel ¶
func NewServiceLabel() *ServiceLabel
type Slat ¶
type Slat struct {
*Service
SlatType *characteristic.SlatType
CurrentSlatState *characteristic.CurrentSlatState
}
type SmokeSensor ¶
type SmokeSensor struct {
*Service
SmokeDetected *characteristic.SmokeDetected
}
func NewSmokeSensor ¶
func NewSmokeSensor() *SmokeSensor
type Speaker ¶
type Speaker struct {
*Service
Mute *characteristic.Mute
}
func NewSpeaker ¶
func NewSpeaker() *Speaker
type StatefulProgrammableSwitch ¶
type StatefulProgrammableSwitch struct {
*Service
ProgrammableSwitchEvent *characteristic.ProgrammableSwitchEvent
ProgrammableSwitchOutputState *characteristic.ProgrammableSwitchOutputState
}
func NewStatefulProgrammableSwitch ¶
func NewStatefulProgrammableSwitch() *StatefulProgrammableSwitch
type StatelessProgrammableSwitch ¶
type StatelessProgrammableSwitch struct {
*Service
ProgrammableSwitchEvent *characteristic.ProgrammableSwitchEvent
}
func NewStatelessProgrammableSwitch ¶
func NewStatelessProgrammableSwitch() *StatelessProgrammableSwitch
type Switch ¶
type Switch struct {
*Service
On *characteristic.On
}
type Television ¶
type Television struct {
*Service
Active *characteristic.Active
ActiveIdentifier *characteristic.ActiveIdentifier
ConfiguredName *characteristic.ConfiguredName
SleepDiscoveryMode *characteristic.SleepDiscoveryMode
Brightness *characteristic.Brightness
ClosedCaptions *characteristic.ClosedCaptions
DisplayOrder *characteristic.DisplayOrder
CurrentMediaState *characteristic.CurrentMediaState
TargetMediaState *characteristic.TargetMediaState
PictureMode *characteristic.PictureMode
PowerModeSelection *characteristic.PowerModeSelection
RemoteKey *characteristic.RemoteKey
}
func NewTelevision ¶
func NewTelevision() *Television
type TemperatureSensor ¶
type TemperatureSensor struct {
*Service
CurrentTemperature *characteristic.CurrentTemperature
}
func NewTemperatureSensor ¶
func NewTemperatureSensor() *TemperatureSensor
type Thermostat ¶
type Thermostat struct {
*Service
CurrentHeatingCoolingState *characteristic.CurrentHeatingCoolingState
TargetHeatingCoolingState *characteristic.TargetHeatingCoolingState
CurrentTemperature *characteristic.CurrentTemperature
TargetTemperature *characteristic.TargetTemperature
TemperatureDisplayUnits *characteristic.TemperatureDisplayUnits
}
func NewThermostat ¶
func NewThermostat() *Thermostat
type TimeInformation ¶
type TimeInformation struct {
*Service
CurrentTime *characteristic.CurrentTime
DayOfTheWeek *characteristic.DayOfTheWeek
TimeUpdate *characteristic.TimeUpdate
}
func NewTimeInformation ¶
func NewTimeInformation() *TimeInformation
type TunneledBTLEAccessoryService ¶
type TunneledBTLEAccessoryService struct {
*Service
Name *characteristic.Name
AccessoryIdentifier *characteristic.AccessoryIdentifier
TunneledAccessoryStateNumber *characteristic.TunneledAccessoryStateNumber
TunneledAccessoryConnected *characteristic.TunneledAccessoryConnected
TunneledAccessoryAdvertising *characteristic.TunneledAccessoryAdvertising
TunnelConnectionTimeout *characteristic.TunnelConnectionTimeout
}
func NewTunneledBTLEAccessoryService ¶
func NewTunneledBTLEAccessoryService() *TunneledBTLEAccessoryService
type Valve ¶
type Valve struct {
*Service
Active *characteristic.Active
InUse *characteristic.InUse
ValveType *characteristic.ValveType
}
type WifiTransport ¶ added in v1.2.5
type WifiTransport struct {
*Service
CurrentTransport *characteristic.CurrentTransport
WifiCapabilities *characteristic.WifiCapabilities
WifiConfigurationControl *characteristic.WifiConfigurationControl
}
func NewWifiTransport ¶ added in v1.2.5
func NewWifiTransport() *WifiTransport
type Window ¶
type Window struct {
*Service
CurrentPosition *characteristic.CurrentPosition
TargetPosition *characteristic.TargetPosition
PositionState *characteristic.PositionState
}
type WindowCovering ¶
type WindowCovering struct {
*Service
CurrentPosition *characteristic.CurrentPosition
TargetPosition *characteristic.TargetPosition
PositionState *characteristic.PositionState
}
func NewWindowCovering ¶
func NewWindowCovering() *WindowCovering
Source Files
¶
- accessory_information.go
- air_purifier.go
- air_quality_sensor.go
- battery_service.go
- bridge_configuration.go
- bridging_state.go
- camera_control.go
- camera_recording_management.go
- camera_rtp_stream_management.go
- carbon_dioxide_sensor.go
- carbon_monoxide_sensor.go
- colored_lightbulb.go
- constants.go
- contact_sensor.go
- cooler.go
- doc.go
- door.go
- doorbell.go
- fan.go
- fan_v2.go
- faucet.go
- filter_maintenance.go
- garage_door_opener.go
- heater.go
- heater_cooler.go
- humidifier_dehumidifier.go
- humidity_sensor.go
- input_source.go
- irrigation_system.go
- leak_sensor.go
- light_sensor.go
- lightbulb.go
- lock_management.go
- lock_mechanism.go
- microphone.go
- motion_sensor.go
- occupancy_sensor.go
- outlet.go
- security_system.go
- service.go
- service_label.go
- slat.go
- smoke_sensor.go
- speaker.go
- stateful_programmable_switch.go
- stateless_programmable_switch.go
- switch.go
- television.go
- temperature_sensor.go
- thermostat.go
- time_information.go
- tunneled_btle_accessory_service.go
- valve.go
- wifitransport.go
- window.go
- window_covering.go
Click to show internal directories.
Click to hide internal directories.