Static FormatsPlease use the Formats const enum above.
Static PermsPlease use the Perms const enum above.
Static Readonly UUIDStatic UnitsPlease use the Units const enum above.
Accepts a function that will be called to retrieve the current value of a Characteristic. The function must return a valid Characteristic value for the Characteristic type. May optionally return a promise.
Characteristic.onGet(async () => {
return true;
});
Accepts a function that will be called when setting the value of a Characteristic. If the characteristic supports Perms.WRITE_RESPONSE and the request requests a write-response value, the returned value will be used. May optionally return a promise.
Characteristic.onSet(async (value: CharacteristicValue) => {
console.log(value);
});
Removes the CharacteristicGetHandler handler which was configured using onGet.
Removes the CharacteristicSetHandler which was configured using onSet.
This method acts similarly to updateValue by setting the current value of the characteristic without calling any CharacteristicEventTypes.SET or onSet handlers. The difference is that this method forces an event notification sent (updateValue only sends one if the value changed). This is especially useful for characteristics like Characteristic.ButtonEvent or Characteristic.ProgrammableSwitchEvent.
The new value.
Optional context: anyPassed to the CharacteristicEventTypes.CHANGE event handler.
Updates the properties of this characteristic. Properties passed via the parameter will be set. Any parameter set to null will be deleted. See CharacteristicProps.
Partial properties object with the desired updates.
This updates the value by calling the CharacteristicEventTypes.SET event handler associated with the characteristic.
This acts the same way as when a HomeKit controller sends a /characteristics request to update the characteristic.
An event notification will be sent to all connected HomeKit controllers which are registered
to receive event notifications for this characteristic.
This method behaves like a updateValue call with the addition that the own CharacteristicEventTypes.SET event handler is called.
The new value.
Note: If you don't want the CharacteristicEventTypes.SET to be called, refer to updateValue.
Sets the state of the characteristic to an errored state.
If a onGet or CharacteristicEventTypes.GET handler is set up, the errored state will be ignored and the characteristic will always query the latest state by calling the provided handler.
If a generic error object is supplied, the characteristic tries to extract a HAPStatus code from the error message string. If not possible a generic HAPStatus.SERVICE_COMMUNICATION_FAILURE will be used. If the supplied error object is an instance of HapStatusError the corresponding status will be used.
This doesn't call any registered onSet or CharacteristicEventTypes.SET handlers.
Have a look at the Presenting Erroneous Accessory State to the User guide for more information on how to present erroneous state to the user.
The error object
Note: Erroneous state is never pushed to the client side. Only, if the HomeKit client requests the current state of the Characteristic, the corresponding HapStatusError is returned. As described above, any onGet or CharacteristicEventTypes.GET handlers have precedence.
This updates the value by calling the CharacteristicEventTypes.SET event handler associated with the characteristic.
This acts the same way as when a HomeKit controller sends a /characteristics request to update the characteristic.
An event notification will be sent to all connected HomeKit controllers which are registered
to receive event notifications for this characteristic.
This method behaves like a updateValue call with the addition that the own CharacteristicEventTypes.SET event handler is called.
The new value.
Optional callback: CharacteristicSetCallbackDeprecated parameter there to provide backwards compatibility. Called once the CharacteristicEventTypes.SET event handler returns.
Optional context: anyPassed to the CharacteristicEventTypes.SET and CharacteristicEventTypes.CHANGE event handler.
Parameter callback is deprecated.
This updates the value by calling the CharacteristicEventTypes.SET event handler associated with the characteristic.
This acts the same way as when a HomeKit controller sends a /characteristics request to update the characteristic.
An event notification will be sent to all connected HomeKit controllers which are registered
to receive event notifications for this characteristic.
This method behaves like a updateValue call with the addition that the own CharacteristicEventTypes.SET event handler is called.
The new value.
Optional context: anyPassed to the CharacteristicEventTypes.SET and CharacteristicEventTypes.CHANGE event handler.
Note: If you don't want the CharacteristicEventTypes.SET to be called, refer to updateValue.
This method can be used to set up additional authorization for a characteristic. For one, it adds the Perms.ADDITIONAL_AUTHORIZATION permission to the characteristic (if it wasn't already) to signal support for additional authorization to HomeKit. Additionally, an AdditionalAuthorizationHandler is set up which is called before a write request is performed.
Additional Authorization Data can be added to SET request via a custom iOS App. Before hap-nodejs executes a write request it will call the AdditionalAuthorizationHandler with 'authData' supplied in the write request. The 'authData' is a base64 encoded string (or undefined if no authData was supplied). The AdditionalAuthorizationHandler must then return true or false to indicate if the write request is authorized and should be accepted.
Handler called to check additional authorization data.
This updates the value of the characteristic. If the value changed, an event notification will be sent to all connected HomeKit controllers which are registered to receive event notifications for this characteristic.
The new value or a Error or HapStatusError.
Note: Refer to the respective overloads for CharacteristicValue or HapStatusError for respective documentation.
This updates the value of the characteristic. If the value changed, an event notification will be sent to all connected HomeKit controllers which are registered to receive event notifications for this characteristic.
The new value.
Sets the state of the characteristic to an errored state. If a onGet or CharacteristicEventTypes.GET handler is set up, the errored state will be ignored and the characteristic will always query the latest state by calling the provided handler.
If a generic error object is supplied, the characteristic tries to extract a HAPStatus code from the error message string. If not possible a generic HAPStatus.SERVICE_COMMUNICATION_FAILURE will be used. If the supplied error object is an instance of HapStatusError the corresponding status will be used.
Have a look at the Presenting Erroneous Accessory State to the User guide for more information on how to present erroneous state to the user.
The error object
Note: Erroneous state is never pushed to the client side. Only, if the HomeKit client requests the current state of the Characteristic, the corresponding HapStatusError is returned. As described above, any onGet or CharacteristicEventTypes.GET handlers have precedence.
This updates the value of the characteristic. If the value changed, an event notification will be sent to all connected HomeKit controllers which are registered to receive event notifications for this characteristic.
The new value.
Optional callback: (() => void)Deprecated parameter there to provide backwards compatibility. Callback is called instantly.
Optional context: anyPassed to the CharacteristicEventTypes.CHANGE event handler.
Parameter callback is deprecated.
This updates the value of the characteristic. If the value changed, an event notification will be sent to all connected HomeKit controllers which are registered to receive event notifications for this characteristic.
The new value.
Optional context: anyPassed to the CharacteristicEventTypes.CHANGE event handler.
This method can be used to gain an Iterator to loop over all valid values defined for this characteristic.
The range of valid values can be defined using three different ways via the CharacteristicProps object (set via the setProps method):
The method will automatically detect which type of valid values definition is used and provide the correct Iterator for that case.
Note: This method is (obviously) only valid for numeric characteristics.
// use the iterator to loop over every valid value...
for (const value of characteristic.validValuesIterator()) {
// Insert logic to run for every
}
// ... or collect them in an array for storage or manipulation
const validValues = Array.from(characteristic.validValuesIterator());
Static AccessStatic AccessStatic AccessStatic AccessoryStatic AccessoryStatic ActiveStatic ActiveStatic ActivityStatic AdministratorStatic AirStatic AirStatic AirStatic AirStatic AppStatic AssetStatic AudioStatic BatteryStatic BrightnessStatic ButtonStatic CCAEnergyStatic CCASignalStatic CameraStatic CarbonStatic CarbonStatic CarbonStatic CarbonStatic CarbonStatic CarbonStatic CategoryRemoved and not used anymore
Static CharacteristicStatic CharacteristicStatic ChargingStatic ClosedStatic ColorStatic ConfigurationStatic ConfigureRemoved and not used anymore
Static ConfigureRemoved and not used anymore
Static ConfiguredStatic ContactStatic CoolingStatic CryptoStatic CurrentStatic CurrentStatic CurrentStatic CurrentStatic CurrentStatic CurrentStatic CurrentStatic CurrentStatic CurrentStatic CurrentStatic CurrentStatic CurrentStatic CurrentStatic CurrentStatic CurrentRemoved and not used anymore
Static CurrentStatic CurrentStatic CurrentStatic DataStatic DataStatic DayoftheRemoved and not used anymore
Static DiagonalStatic DigitalStatic DiscoverRemoved and not used anymore
Static DiscoveredRemoved and not used anymore
Static DisplayStatic EventStatic EventStatic EventStatic FilterStatic FilterStatic FirmwareStatic FirmwareStatic FirmwareStatic HardwareStatic HardwareStatic HeartStatic HeatingStatic HoldStatic HomeStatic HueStatic IdentifierStatic IdentifyStatic ImageStatic ImageStatic InStatic InputStatic InputStatic IsStatic LeakStatic LinkRemoved and not used anymore
Static ListStatic LockStatic LockStatic LockStatic LockStatic LockStatic LockStatic LogsStatic MACRetransmissionStatic MACTransmissionStatic ManagedStatic ManuallyStatic ManufacturerStatic MaximumStatic MetricsStatic ModelStatic MotionStatic MultifunctionStatic MuteStatic NFCAccessStatic NFCAccessStatic NameStatic NetworkStatic NetworkStatic NetworkStatic NightStatic NitrogenStatic ObstructionStatic OccupancyStatic OnStatic OperatingStatic OpticalStatic OutletStatic OzoneStatic PM10Static PM2_Static PairStatic PairStatic PairingStatic PasswordStatic PeriodicStatic PictureStatic PingStatic PositionStatic PowerStatic ProductStatic ProgramStatic ProgrammableStatic ProgrammableStatic ReachableRemoved and not used anymore
Static ReceivedStatic ReceiverStatic RecordingStatic RelativeStatic RelativeStatic RelayStatic RelayStatic RelayStatic RemainingStatic RemoteStatic ResetStatic RotationStatic RotationStatic RouterStatic SaturationStatic SecurityStatic SecurityStatic SecurityStatic SelectedStatic SelectedStatic SelectedStatic SelectedRTPStreamStatic SelectedStatic SerialStatic ServiceStatic ServiceStatic SetStatic SetupStatic SetupStatic SetupStatic SignalStatic SiriStatic SiriStatic SiriStatic SiriStatic SiriStatic SiriStatic SiriStatic SlatStatic SleepStatic SleepStatic SmokeStatic SoftwareStatic StagedStatic StatusStatic StatusStatic StatusStatic StatusStatic StatusStatic StreamingStatic SulphurStatic SupportedStatic SupportedStatic SupportedStatic SupportedStatic SupportedStatic SupportedStatic SupportedStatic SupportedStatic SupportedStatic SupportedStatic SupportedRTPConfigurationStatic SupportedStatic SupportedStatic SupportedStatic SupportedStatic SupportedStatic SwingStatic TapStatic TargetStatic TargetRemoved and not used anymore
Static TargetStatic TargetStatic TargetStatic TargetStatic TargetStatic TargetStatic TargetStatic TargetStatic TargetStatic TargetStatic TargetStatic TargetRemoved and not used anymore
Static TargetStatic TargetStatic TargetStatic TargetStatic TemperatureStatic ThirdStatic ThreadStatic ThreadStatic ThreadStatic ThreadStatic TimeRemoved and not used anymore
Static TokenStatic TransmitStatic TunnelStatic TunneledStatic TunneledStatic TunneledStatic VOCDensityStatic ValveStatic VersionStatic VideoStatic VolumeStatic VolumeStatic VolumeStatic WANConfigurationStatic WANStatusStatic WakeStatic WaterStatic WiStatic WiStatic Wi
Characteristic "Thread Status"