service

package
v1.1.1-0...-6dff958 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 31, 2019 License: Apache-2.0 Imports: 1 Imported by: 0

README

Service Characteristics ID
Accessory Information Identify
Manufacturer
Model
Name
Serial Number
Firmware Revision
Hardware Revision Optional
Accessory Flags Optional		 3E
Air Purifier Active
Current Air Purifier State
Target Air Purifier State
Lock Physical Controls Optional
Name Optional
Swing Mode Optional
Rotation Speed Optional		 BB
Air Quality Sensor Air Quality
Status Active Optional
Status Fault Optional
Status Tampered Optional
Status Low Battery Optional
Name Optional
Ozone Density Optional
Nitrogen Dioxide Density Optional
Sulphur Dioxide Density Optional
PM2.5 Density Optional
PM10 Density Optional
VOC Density Optional
Carbon Monoxide Level Optional
Carbon Dioxide Level Optional		 8D
Battery Service Battery Level
Charging State
Status Low Battery
Name Optional		 96
Camera RTP Stream Management Supported Video Stream Configuration
Supported Audio Stream Configuration
Supported RTP Configuration
Selected RTP Stream Configuration
Streaming Status
Setup Endpoints
Name Optional		 110
Carbon Dioxide Sensor Carbon Dioxide Detected
Status Active Optional
Status Fault Optional
Status Low Battery Optional
Status Tampered Optional
Carbon Dioxide Level Optional
Carbon Dioxide Peak Level Optional
Name Optional		 97
Carbon Monoxide Sensor Carbon Monoxide Detected
Status Active Optional
Status Fault Optional
Status Low Battery Optional
Status Tampered Optional
Carbon Monoxide Level Optional
Carbon Monoxide Peak Level Optional
Name Optional		 7F
Contact Sensor Contact Sensor State
Status Active Optional
Status Fault Optional
Status Tampered Optional
Status Low Battery Optional
Name Optional		 80
Door Current Position
Position State
Target Position
Hold Position Optional
Obstruction Detected Optional
Name Optional		 81
Doorbell Programmable Switch Event
Brightness Optional
Volume Optional
Name Optional		 121
Fan On
Rotation Direction Optional
Rotation Speed Optional
Name Optional		 40
Fan v2 Active
Current Fan State Optional
Target Fan State Optional
Lock Physical Controls Optional
Name Optional
Rotation Direction Optional
Rotation Speed Optional
Swing Mode Optional		 B7
Filter Maintenance Filter Change Indication
Filter Life Level Optional
Reset Filter Indication Optional
Name Optional		 BA
Faucet Active
Name Optional
Status Fault Optional		 D7
Garage Door Opener Current Door State
Target Door State
Obstruction Detected
Lock Current State Optional
Lock Target State Optional
Name Optional		 41
Heater Cooler Active
Current Heater Cooler State
Target Heater Cooler State
Current Temperature
Lock Physical Controls Optional
Name Optional
Swing Mode Optional
Cooling Threshold Temperature Optional
Heating Threshold Temperature Optional
Temperature Display Units Optional
Rotation Speed Optional		 BC
Humidifier Dehumidifier Current Relative Humidity
Current Humidifier Dehumidifier State
Target Humidifier Dehumidifier State
Active
Lock Physical Controls Optional
Name Optional
Swing Mode Optional
Water Level Optional
Relative Humidity Dehumidifier Threshold Optional
Relative Humidity Humidifier Threshold Optional
Rotation Speed Optional		 BD
Humidity Sensor Current Relative Humidity
Status Active Optional
Status Fault Optional
Status Tampered Optional
Status Low Battery Optional
Name Optional		 82
Irrigation System Active
Program Mode
In Use
Name Optional
Remaining Duration Optional
Status Fault Optional		 CF
Leak Sensor Leak Detected
Status Active Optional
Status Fault Optional
Status Tampered Optional
Status Low Battery Optional
Name Optional		 83
Light Sensor Current Ambient Light Level
Name Optional
Status Active Optional
Status Fault Optional
Status Tampered Optional
Status Low Battery Optional		 84
Lightbulb On
Brightness Optional
Hue Optional
Saturation Optional
Name Optional		 43
Lock Management Lock Control Point
Version
Logs Optional
Audio Feedback Optional
Lock Management Auto Security Timeout Optional
Administrator Only Access Optional
Lock Last Known Action Optional
Current Door State Optional
Motion Detected Optional
Name Optional		 44
Lock Mechanism Lock Current State
Lock Target State
Name Optional		 45
Microphone Volume
Mute
Name Optional		 112
Motion Sensor Motion Detected
Status Active Optional
Status Fault Optional
Status Tampered Optional
Status Low Battery Optional
Name Optional		 85
Occupancy Sensor Occupancy Detected
Name Optional
Status Active Optional
Status Fault Optional
Status Tampered Optional
Status Low Battery Optional		 86
Outlet On
Outlet In Use
Name Optional		 47
Security System Security System Current State
Security System Target State
Status Fault Optional
Status Tampered Optional
Security System Alarm Type Optional
Name Optional		 7E
Service Label Service Label Namespace
Name Optional		 CC
Slat Slat Type
Current Slat State
Name Optional
Current Tilt Angle Optional
Target Tilt Angle Optional
Swing Mode Optional		 B9
Smoke Sensor Smoke Detected
Status Active Optional
Status Fault Optional
Status Tampered Optional
Status Low Battery Optional
Name Optional		 87
Speaker Mute
Name Optional
Volume Optional		 113
Stateless Programmable Switch Programmable Switch Event
Name Optional
Service Label Index Optional		 89
Switch On
Name Optional		 49
Temperature Sensor Current Temperature
Status Active Optional
Status Fault Optional
Status Low Battery Optional
Status Tampered Optional
Name Optional		 8A
Thermostat Current Heating Cooling State
Target Heating Cooling State
Current Temperature
Target Temperature
Temperature Display Units
Current Relative Humidity Optional
Target Relative Humidity Optional
Cooling Threshold Temperature Optional
Heating Threshold Temperature Optional
Name Optional		 4A
Valve Active
In Use
Valve Type
Set Duration Optional
Remaining Duration Optional
Is Configured Optional
Service Label Index Optional
Status Fault Optional
Name Optional		 D0
Window Current Position
Target Position
Position State
Hold Position Optional
Obstruction Detected Optional
Name Optional		 8B
Window Covering Current Position
Target Position
Position State
Hold Position Optional
Target Horizontal Tilt Angle Optional
Target Vertical Tilt Angle Optional
Current Horizontal Tilt Angle Optional
Current Vertical Tilt Angle Optional
Obstruction Detected Optional
Name Optional		 8C
Television Active
Active Identifier
Configured Name
Sleep Discovery Mode
Brightness Optional
Closed Captions Optional
Display Order Optional
Current Media State Optional
Target Media State Optional
Picture Mode Optional
Power Mode Selection Optional
Remote Key Optional		 D8
Input Source Configured Name
Input Source Type
Is Configured
Current Visibility State
Identifier Optional
Input Device Type Optional
Target Visibility State Optional
Name Optional		 D9

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

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

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 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 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

	HardwareRevision *characteristic.HardwareRevision
	AccessoryFlags   *characteristic.AccessoryFlags
}

func NewAccessoryInformation 

func NewAccessoryInformation() *AccessoryInformation

type AirPurifier 

type AirPurifier struct {
	*Service

	Active                  *characteristic.Active
	CurrentAirPurifierState *characteristic.CurrentAirPurifierState
	TargetAirPurifierState  *characteristic.TargetAirPurifierState

	LockPhysicalControls *characteristic.LockPhysicalControls
	Name                 *characteristic.Name
	SwingMode            *characteristic.SwingMode
	RotationSpeed        *characteristic.RotationSpeed
}

func NewAirPurifier 

func NewAirPurifier() *AirPurifier

type AirQualitySensor 

type AirQualitySensor struct {
	*Service

	AirQuality *characteristic.AirQuality

	StatusActive           *characteristic.StatusActive
	StatusFault            *characteristic.StatusFault
	StatusTampered         *characteristic.StatusTampered
	StatusLowBattery       *characteristic.StatusLowBattery
	Name                   *characteristic.Name
	OzoneDensity           *characteristic.OzoneDensity
	NitrogenDioxideDensity *characteristic.NitrogenDioxideDensity
	SulphurDioxideDensity  *characteristic.SulphurDioxideDensity
	PM2_5Density           *characteristic.PM2_5Density
	PM10Density            *characteristic.PM10Density
	VOCDensity             *characteristic.VOCDensity
	CarbonMonoxideLevel    *characteristic.CarbonMonoxideLevel
	CarbonDioxideLevel     *characteristic.CarbonDioxideLevel
}

func NewAirQualitySensor 

func NewAirQualitySensor() *AirQualitySensor

type BatteryService 

type BatteryService struct {
	*Service

	BatteryLevel     *characteristic.BatteryLevel
	ChargingState    *characteristic.ChargingState
	StatusLowBattery *characteristic.StatusLowBattery

	Name *characteristic.Name
}

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

	Name *characteristic.Name
}

func NewCameraRTPStreamManagement 

func NewCameraRTPStreamManagement() *CameraRTPStreamManagement

type CarbonDioxideSensor 

type CarbonDioxideSensor struct {
	*Service

	CarbonDioxideDetected *characteristic.CarbonDioxideDetected

	StatusActive           *characteristic.StatusActive
	StatusFault            *characteristic.StatusFault
	StatusLowBattery       *characteristic.StatusLowBattery
	StatusTampered         *characteristic.StatusTampered
	CarbonDioxideLevel     *characteristic.CarbonDioxideLevel
	CarbonDioxidePeakLevel *characteristic.CarbonDioxidePeakLevel
	Name                   *characteristic.Name
}

func NewCarbonDioxideSensor 

func NewCarbonDioxideSensor() *CarbonDioxideSensor

type CarbonMonoxideSensor 

type CarbonMonoxideSensor struct {
	*Service

	CarbonMonoxideDetected *characteristic.CarbonMonoxideDetected

	StatusActive            *characteristic.StatusActive
	StatusFault             *characteristic.StatusFault
	StatusLowBattery        *characteristic.StatusLowBattery
	StatusTampered          *characteristic.StatusTampered
	CarbonMonoxideLevel     *characteristic.CarbonMonoxideLevel
	CarbonMonoxidePeakLevel *characteristic.CarbonMonoxidePeakLevel
	Name                    *characteristic.Name
}

func NewCarbonMonoxideSensor 

func NewCarbonMonoxideSensor() *CarbonMonoxideSensor

type ContactSensor 

type ContactSensor struct {
	*Service

	ContactSensorState *characteristic.ContactSensorState

	StatusActive     *characteristic.StatusActive
	StatusFault      *characteristic.StatusFault
	StatusTampered   *characteristic.StatusTampered
	StatusLowBattery *characteristic.StatusLowBattery
	Name             *characteristic.Name
}

func NewContactSensor 

func NewContactSensor() *ContactSensor

type Door 

type Door struct {
	*Service

	CurrentPosition *characteristic.CurrentPosition
	PositionState   *characteristic.PositionState
	TargetPosition  *characteristic.TargetPosition

	HoldPosition        *characteristic.HoldPosition
	ObstructionDetected *characteristic.ObstructionDetected
	Name                *characteristic.Name
}

func NewDoor 

func NewDoor() *Door

type Doorbell 

type Doorbell struct {
	*Service

	ProgrammableSwitchEvent *characteristic.ProgrammableSwitchEvent

	Brightness *characteristic.Brightness
	Volume     *characteristic.Volume
	Name       *characteristic.Name
}

func NewDoorbell 

func NewDoorbell() *Doorbell

type Fan 

type Fan struct {
	*Service

	On *characteristic.On

	RotationDirection *characteristic.RotationDirection
	RotationSpeed     *characteristic.RotationSpeed
	Name              *characteristic.Name
}

func NewFan 

func NewFan() *Fan

type FanV2 

type FanV2 struct {
	*Service

	Active *characteristic.Active

	CurrentFanState      *characteristic.CurrentFanState
	TargetFanState       *characteristic.TargetFanState
	LockPhysicalControls *characteristic.LockPhysicalControls
	Name                 *characteristic.Name
	RotationDirection    *characteristic.RotationDirection
	RotationSpeed        *characteristic.RotationSpeed
	SwingMode            *characteristic.SwingMode
}

func NewFanV2 

func NewFanV2() *FanV2

type Faucet 

type Faucet struct {
	*Service

	Active *characteristic.Active

	Name        *characteristic.Name
	StatusFault *characteristic.StatusFault
}

func NewFaucet 

func NewFaucet() *Faucet

type FilterMaintenance 

type FilterMaintenance struct {
	*Service

	FilterChangeIndication *characteristic.FilterChangeIndication

	FilterLifeLevel       *characteristic.FilterLifeLevel
	ResetFilterIndication *characteristic.ResetFilterIndication
	Name                  *characteristic.Name
}

func NewFilterMaintenance 

func NewFilterMaintenance() *FilterMaintenance

type GarageDoorOpener 

type GarageDoorOpener struct {
	*Service

	CurrentDoorState    *characteristic.CurrentDoorState
	TargetDoorState     *characteristic.TargetDoorState
	ObstructionDetected *characteristic.ObstructionDetected

	LockCurrentState *characteristic.LockCurrentState
	LockTargetState  *characteristic.LockTargetState
	Name             *characteristic.Name
}

func NewGarageDoorOpener 

func NewGarageDoorOpener() *GarageDoorOpener

type HeaterCooler 

type HeaterCooler struct {
	*Service

	Active                   *characteristic.Active
	CurrentHeaterCoolerState *characteristic.CurrentHeaterCoolerState
	TargetHeaterCoolerState  *characteristic.TargetHeaterCoolerState
	CurrentTemperature       *characteristic.CurrentTemperature

	LockPhysicalControls        *characteristic.LockPhysicalControls
	Name                        *characteristic.Name
	SwingMode                   *characteristic.SwingMode
	CoolingThresholdTemperature *characteristic.CoolingThresholdTemperature
	HeatingThresholdTemperature *characteristic.HeatingThresholdTemperature
	TemperatureDisplayUnits     *characteristic.TemperatureDisplayUnits
	RotationSpeed               *characteristic.RotationSpeed
}

func NewHeaterCooler 

func NewHeaterCooler() *HeaterCooler

type HumidifierDehumidifier 

type HumidifierDehumidifier struct {
	*Service

	CurrentRelativeHumidity            *characteristic.CurrentRelativeHumidity
	CurrentHumidifierDehumidifierState *characteristic.CurrentHumidifierDehumidifierState
	TargetHumidifierDehumidifierState  *characteristic.TargetHumidifierDehumidifierState
	Active                             *characteristic.Active

	LockPhysicalControls                  *characteristic.LockPhysicalControls
	Name                                  *characteristic.Name
	SwingMode                             *characteristic.SwingMode
	WaterLevel                            *characteristic.WaterLevel
	RelativeHumidityDehumidifierThreshold *characteristic.RelativeHumidityDehumidifierThreshold
	RelativeHumidityHumidifierThreshold   *characteristic.RelativeHumidityHumidifierThreshold
	RotationSpeed                         *characteristic.RotationSpeed
}

func NewHumidifierDehumidifier 

func NewHumidifierDehumidifier() *HumidifierDehumidifier

type HumiditySensor 

type HumiditySensor struct {
	*Service

	CurrentRelativeHumidity *characteristic.CurrentRelativeHumidity

	StatusActive     *characteristic.StatusActive
	StatusFault      *characteristic.StatusFault
	StatusTampered   *characteristic.StatusTampered
	StatusLowBattery *characteristic.StatusLowBattery
	Name             *characteristic.Name
}

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

	Name              *characteristic.Name
	RemainingDuration *characteristic.RemainingDuration
	StatusFault       *characteristic.StatusFault
}

func NewIrrigationSystem 

func NewIrrigationSystem() *IrrigationSystem

type LeakSensor 

type LeakSensor struct {
	*Service

	LeakDetected *characteristic.LeakDetected

	StatusActive     *characteristic.StatusActive
	StatusFault      *characteristic.StatusFault
	StatusTampered   *characteristic.StatusTampered
	StatusLowBattery *characteristic.StatusLowBattery
	Name             *characteristic.Name
}

func NewLeakSensor 

func NewLeakSensor() *LeakSensor

type LightSensor 

type LightSensor struct {
	*Service

	CurrentAmbientLightLevel *characteristic.CurrentAmbientLightLevel

	Name             *characteristic.Name
	StatusActive     *characteristic.StatusActive
	StatusFault      *characteristic.StatusFault
	StatusTampered   *characteristic.StatusTampered
	StatusLowBattery *characteristic.StatusLowBattery
}

func NewLightSensor 

func NewLightSensor() *LightSensor

type Lightbulb 

type Lightbulb struct {
	*Service

	On *characteristic.On

	Brightness *characteristic.Brightness
	Hue        *characteristic.Hue
	Saturation *characteristic.Saturation
	Name       *characteristic.Name
}

func NewLightbulb 

func NewLightbulb() *Lightbulb

type LockManagement 

type LockManagement struct {
	*Service

	LockControlPoint *characteristic.LockControlPoint
	Version          *characteristic.Version

	Logs                              *characteristic.Logs
	AudioFeedback                     *characteristic.AudioFeedback
	LockManagementAutoSecurityTimeout *characteristic.LockManagementAutoSecurityTimeout
	AdministratorOnlyAccess           *characteristic.AdministratorOnlyAccess
	LockLastKnownAction               *characteristic.LockLastKnownAction
	CurrentDoorState                  *characteristic.CurrentDoorState
	MotionDetected                    *characteristic.MotionDetected
	Name                              *characteristic.Name
}

func NewLockManagement 

func NewLockManagement() *LockManagement

type LockMechanism 

type LockMechanism struct {
	*Service

	LockCurrentState *characteristic.LockCurrentState
	LockTargetState  *characteristic.LockTargetState

	Name *characteristic.Name
}

func NewLockMechanism 

func NewLockMechanism() *LockMechanism

type Microphone 

type Microphone struct {
	*Service

	Volume *characteristic.Volume
	Mute   *characteristic.Mute

	Name *characteristic.Name
}

func NewMicrophone 

func NewMicrophone() *Microphone

type MotionSensor 

type MotionSensor struct {
	*Service

	MotionDetected *characteristic.MotionDetected

	StatusActive     *characteristic.StatusActive
	StatusFault      *characteristic.StatusFault
	StatusTampered   *characteristic.StatusTampered
	StatusLowBattery *characteristic.StatusLowBattery
	Name             *characteristic.Name
}

func NewMotionSensor 

func NewMotionSensor() *MotionSensor

type OccupancySensor 

type OccupancySensor struct {
	*Service

	OccupancyDetected *characteristic.OccupancyDetected

	Name             *characteristic.Name
	StatusActive     *characteristic.StatusActive
	StatusFault      *characteristic.StatusFault
	StatusTampered   *characteristic.StatusTampered
	StatusLowBattery *characteristic.StatusLowBattery
}

func NewOccupancySensor 

func NewOccupancySensor() *OccupancySensor

type Outlet 

type Outlet struct {
	*Service

	On          *characteristic.On
	OutletInUse *characteristic.OutletInUse

	Name *characteristic.Name
}

func NewOutlet 

func NewOutlet() *Outlet

type SecuritySystem 

type SecuritySystem struct {
	*Service

	SecuritySystemCurrentState *characteristic.SecuritySystemCurrentState
	SecuritySystemTargetState  *characteristic.SecuritySystemTargetState

	StatusFault             *characteristic.StatusFault
	StatusTampered          *characteristic.StatusTampered
	SecuritySystemAlarmType *characteristic.SecuritySystemAlarmType
	Name                    *characteristic.Name
}

func NewSecuritySystem 

func NewSecuritySystem() *SecuritySystem

type Service 

type Service struct {
	ID              int64                            `json:"iid"`
	Type            string                           `json:"type"`
	Characteristics []*characteristic.Characteristic `json:"characteristics"`
	Hidden          *bool                            `json:"hidden,omitempty"`
	Primary         *bool                            `json:"primary,omitempty"`
	Linked          []int64                          `json:"linked,omitempty"`
}

Service is an HomeKit service consisting of characteristics.

func New 

func New(typ string) *Service

New returns a new service.

func (*Service) AddCharacteristic 

func (s *Service) AddCharacteristic(c *characteristic.Characteristic)

func (*Service) AddLinkedService 

func (s *Service) AddLinkedService(other *Service)

func (*Service) Equal 

func (s *Service) Equal(other interface{}) bool

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) GetID 

func (s *Service) GetID() int64

GetID returns the service id.

func (*Service) GetType 

func (s *Service) GetType() string

GetType of the service.

func (*Service) IsHidden 

func (s *Service) IsHidden() bool

func (*Service) IsPrimary 

func (s *Service) IsPrimary() bool

func (*Service) SetHidden 

func (s *Service) SetHidden(b bool)

func (*Service) SetID 

func (s *Service) SetID(id int64)

SetID sets the service id.

func (*Service) SetPrimary 

func (s *Service) SetPrimary(b bool)

type ServiceLabel 

type ServiceLabel struct {
	*Service

	ServiceLabelNamespace *characteristic.ServiceLabelNamespace

	Name *characteristic.Name
}

func NewServiceLabel 

func NewServiceLabel() *ServiceLabel

type ServiceType 

type ServiceType string

ServiceType is the type for all HomeKit service types.

type Slat 

type Slat struct {
	*Service

	SlatType         *characteristic.SlatType
	CurrentSlatState *characteristic.CurrentSlatState

	Name             *characteristic.Name
	CurrentTiltAngle *characteristic.CurrentTiltAngle
	TargetTiltAngle  *characteristic.TargetTiltAngle
	SwingMode        *characteristic.SwingMode
}

func NewSlat 

func NewSlat() *Slat

type SmokeSensor 

type SmokeSensor struct {
	*Service

	SmokeDetected *characteristic.SmokeDetected

	StatusActive     *characteristic.StatusActive
	StatusFault      *characteristic.StatusFault
	StatusTampered   *characteristic.StatusTampered
	StatusLowBattery *characteristic.StatusLowBattery
	Name             *characteristic.Name
}

func NewSmokeSensor 

func NewSmokeSensor() *SmokeSensor

type Speaker 

type Speaker struct {
	*Service

	Mute *characteristic.Mute

	Name   *characteristic.Name
	Volume *characteristic.Volume
}

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

	Name              *characteristic.Name
	ServiceLabelIndex *characteristic.ServiceLabelIndex
}

func NewStatelessProgrammableSwitch 

func NewStatelessProgrammableSwitch() *StatelessProgrammableSwitch

type Switch 

type Switch struct {
	*Service

	On *characteristic.On

	Name *characteristic.Name
}

func NewSwitch 

func NewSwitch() *Switch

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

	StatusActive     *characteristic.StatusActive
	StatusFault      *characteristic.StatusFault
	StatusLowBattery *characteristic.StatusLowBattery
	StatusTampered   *characteristic.StatusTampered
	Name             *characteristic.Name
}

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

	CurrentRelativeHumidity     *characteristic.CurrentRelativeHumidity
	TargetRelativeHumidity      *characteristic.TargetRelativeHumidity
	CoolingThresholdTemperature *characteristic.CoolingThresholdTemperature
	HeatingThresholdTemperature *characteristic.HeatingThresholdTemperature
	Name                        *characteristic.Name
}

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

	SetDuration       *characteristic.SetDuration
	RemainingDuration *characteristic.RemainingDuration
	IsConfigured      *characteristic.IsConfigured
	ServiceLabelIndex *characteristic.ServiceLabelIndex
	StatusFault       *characteristic.StatusFault
	Name              *characteristic.Name
}

func NewValve 

func NewValve() *Valve

type Window 

type Window struct {
	*Service

	CurrentPosition *characteristic.CurrentPosition
	TargetPosition  *characteristic.TargetPosition
	PositionState   *characteristic.PositionState

	HoldPosition        *characteristic.HoldPosition
	ObstructionDetected *characteristic.ObstructionDetected
	Name                *characteristic.Name
}

func NewWindow 

func NewWindow() *Window

type WindowCovering 

type WindowCovering struct {
	*Service

	CurrentPosition *characteristic.CurrentPosition
	TargetPosition  *characteristic.TargetPosition
	PositionState   *characteristic.PositionState

	HoldPosition               *characteristic.HoldPosition
	TargetHorizontalTiltAngle  *characteristic.TargetHorizontalTiltAngle
	TargetVerticalTiltAngle    *characteristic.TargetVerticalTiltAngle
	CurrentHorizontalTiltAngle *characteristic.CurrentHorizontalTiltAngle
	CurrentVerticalTiltAngle   *characteristic.CurrentVerticalTiltAngle
	ObstructionDetected        *characteristic.ObstructionDetected
	Name                       *characteristic.Name
}

func NewWindowCovering 

func NewWindowCovering() *WindowCovering

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.