Characteristic "Crypto Hash"

Hierarchy

Constructors

Properties

Characteristic Definitions

AccessCodeControlPoint AccessCodeSupportedConfiguration AccessControlLevel AccessoryFlags AccessoryIdentifier Active ActiveIdentifier ActivityInterval AdministratorOnlyAccess AirParticulateDensity AirParticulateSize AirPlayEnable AirQuality AppMatchingIdentifier AssetUpdateReadiness AudioFeedback BatteryLevel Brightness ButtonEvent CCAEnergyDetectThreshold CCASignalDetectThreshold CameraOperatingModeIndicator CarbonDioxideDetected CarbonDioxideLevel CarbonDioxidePeakLevel CarbonMonoxideDetected CarbonMonoxideLevel CarbonMonoxidePeakLevel Category CharacteristicValueActiveTransitionCount CharacteristicValueTransitionControl ChargingState ClosedCaptions ColorTemperature ConfigurationState ConfigureBridgedAccessory ConfigureBridgedAccessoryStatus ConfiguredName ContactSensorState CoolingThresholdTemperature CryptoHash CurrentAirPurifierState CurrentAmbientLightLevel CurrentDoorState CurrentFanState CurrentHeaterCoolerState CurrentHeatingCoolingState CurrentHorizontalTiltAngle CurrentHumidifierDehumidifierState CurrentMediaState CurrentPosition CurrentRelativeHumidity CurrentSlatState CurrentTemperature CurrentTiltAngle CurrentTime CurrentTransport CurrentVerticalTiltAngle CurrentVisibilityState DataStreamHAPTransport DataStreamHAPTransportInterrupt DayoftheWeek DiagonalFieldOfView DigitalZoom DiscoverBridgedAccessories DiscoveredBridgedAccessories DisplayOrder EventRetransmissionMaximum EventSnapshotsActive EventTransmissionCounters FilterChangeIndication FilterLifeLevel FirmwareRevision FirmwareUpdateReadiness FirmwareUpdateStatus HardwareFinish HardwareRevision HeartBeat HeatingThresholdTemperature HoldPosition HomeKitCameraActive Hue Identifier Identify ImageMirroring ImageRotation InUse InputDeviceType InputSourceType IsConfigured LeakDetected LinkQuality ListPairings LockControlPoint LockCurrentState LockLastKnownAction LockManagementAutoSecurityTimeout LockPhysicalControls LockTargetState Logs MACRetransmissionMaximum MACTransmissionCounters ManagedNetworkEnable ManuallyDisabled Manufacturer MaximumTransmitPower MetricsBufferFullState Model MotionDetected MultifunctionButton Mute NFCAccessControlPoint NFCAccessSupportedConfiguration Name NetworkAccessViolationControl NetworkClientProfileControl NetworkClientStatusControl NightVision NitrogenDioxideDensity ObstructionDetected OccupancyDetected On OperatingStateResponse OpticalZoom OutletInUse OzoneDensity PM10Density PM2_5Density PairSetup PairVerify PairingFeatures PasswordSetting PeriodicSnapshotsActive PictureMode Ping PositionState PowerModeSelection ProductData ProgramMode ProgrammableSwitchEvent ProgrammableSwitchOutputState Reachable ReceivedSignalStrengthIndication ReceiverSensitivity RecordingAudioActive RelativeHumidityDehumidifierThreshold RelativeHumidityHumidifierThreshold RelayControlPoint RelayEnabled RelayState RemainingDuration RemoteKey ResetFilterIndication RotationDirection RotationSpeed RouterStatus Saturation SecuritySystemAlarmType SecuritySystemCurrentState SecuritySystemTargetState SelectedAudioStreamConfiguration SelectedCameraRecordingConfiguration SelectedDiagnosticsModes SelectedRTPStreamConfiguration SelectedSleepConfiguration SerialNumber ServiceLabelIndex ServiceLabelNamespace SetDuration SetupDataStreamTransport SetupEndpoints SetupTransferTransport SignalToNoiseRatio SiriEnable SiriEndpointSessionStatus SiriEngineVersion SiriInputType SiriLightOnUse SiriListening SiriTouchToUse SlatType SleepDiscoveryMode SleepInterval SmokeDetected SoftwareRevision StagedFirmwareVersion StatusActive StatusFault StatusJammed StatusLowBattery StatusTampered StreamingStatus SulphurDioxideDensity SupportedAssetTypes SupportedAudioRecordingConfiguration SupportedAudioStreamConfiguration SupportedCameraRecordingConfiguration SupportedCharacteristicValueTransitionConfiguration SupportedDataStreamTransportConfiguration SupportedDiagnosticsModes SupportedDiagnosticsSnapshot SupportedFirmwareUpdateConfiguration SupportedMetrics SupportedRTPConfiguration SupportedRouterConfiguration SupportedSleepConfiguration SupportedTransferTransportConfiguration SupportedVideoRecordingConfiguration SupportedVideoStreamConfiguration SwingMode TapType TargetAirPurifierState TargetAirQuality TargetControlList TargetControlSupportedConfiguration TargetDoorState TargetFanState TargetHeaterCoolerState TargetHeatingCoolingState TargetHorizontalTiltAngle TargetHumidifierDehumidifierState TargetMediaState TargetPosition TargetRelativeHumidity TargetSlatState TargetTemperature TargetTiltAngle TargetVerticalTiltAngle TargetVisibilityState TemperatureDisplayUnits ThirdPartyCameraActive ThreadControlPoint ThreadNodeCapabilities ThreadOpenThreadVersion ThreadStatus TimeUpdate Token TransmitPower TunnelConnectionTimeout TunneledAccessoryAdvertising TunneledAccessoryConnected TunneledAccessoryStateNumber VOCDensity ValveType Version VideoAnalysisActive Volume VolumeControlType VolumeSelector WANConfigurationList WANStatusList WakeConfiguration WaterLevel WiFiCapabilities WiFiConfigurationControl WiFiSatelliteStatus

Methods

Constructors

Properties

UUID: string
displayName: string
iid: Nullable<number> = null
Formats: typeof Formats = Formats

Deprecated

Please use the Formats const enum above.

Perms: typeof Perms = Perms

Deprecated

Please use the Perms const enum above.

UUID: string = "00000250-0000-1000-8000-0026BB765291"
Units: typeof Units = Units

Deprecated

Please use the Units const enum above.

Characteristic Definitions

AccessCodeControlPoint: typeof AccessCodeControlPoint
AccessCodeSupportedConfiguration: typeof AccessCodeSupportedConfiguration
AccessControlLevel: typeof AccessControlLevel
AccessoryFlags: typeof AccessoryFlags
AccessoryIdentifier: typeof AccessoryIdentifier
Active: typeof Active
ActiveIdentifier: typeof ActiveIdentifier
ActivityInterval: typeof ActivityInterval
AdministratorOnlyAccess: typeof AdministratorOnlyAccess
AirParticulateDensity: typeof AirParticulateDensity
AirParticulateSize: typeof AirParticulateSize
AirPlayEnable: typeof AirPlayEnable
AirQuality: typeof AirQuality
AppMatchingIdentifier: typeof AppMatchingIdentifier
AssetUpdateReadiness: typeof AssetUpdateReadiness
AudioFeedback: typeof AudioFeedback
BatteryLevel: typeof BatteryLevel
Brightness: typeof Brightness
ButtonEvent: typeof ButtonEvent
CCAEnergyDetectThreshold: typeof CCAEnergyDetectThreshold
CCASignalDetectThreshold: typeof CCASignalDetectThreshold
CameraOperatingModeIndicator: typeof CameraOperatingModeIndicator
CarbonDioxideDetected: typeof CarbonDioxideDetected
CarbonDioxideLevel: typeof CarbonDioxideLevel
CarbonDioxidePeakLevel: typeof CarbonDioxidePeakLevel
CarbonMonoxideDetected: typeof CarbonMonoxideDetected
CarbonMonoxideLevel: typeof CarbonMonoxideLevel
CarbonMonoxidePeakLevel: typeof CarbonMonoxidePeakLevel
Category: typeof Category

Deprecated

Removed and not used anymore

CharacteristicValueActiveTransitionCount: typeof CharacteristicValueActiveTransitionCount
CharacteristicValueTransitionControl: typeof CharacteristicValueTransitionControl
ChargingState: typeof ChargingState
ClosedCaptions: typeof ClosedCaptions
ColorTemperature: typeof ColorTemperature
ConfigurationState: typeof ConfigurationState
ConfigureBridgedAccessory: typeof ConfigureBridgedAccessory

Deprecated

Removed and not used anymore

ConfigureBridgedAccessoryStatus: typeof ConfigureBridgedAccessoryStatus

Deprecated

Removed and not used anymore

ConfiguredName: typeof ConfiguredName
ContactSensorState: typeof ContactSensorState
CoolingThresholdTemperature: typeof CoolingThresholdTemperature
CryptoHash: typeof CryptoHash
CurrentAirPurifierState: typeof CurrentAirPurifierState
CurrentAmbientLightLevel: typeof CurrentAmbientLightLevel
CurrentDoorState: typeof CurrentDoorState
CurrentFanState: typeof CurrentFanState
CurrentHeaterCoolerState: typeof CurrentHeaterCoolerState
CurrentHeatingCoolingState: typeof CurrentHeatingCoolingState
CurrentHorizontalTiltAngle: typeof CurrentHorizontalTiltAngle
CurrentHumidifierDehumidifierState: typeof CurrentHumidifierDehumidifierState
CurrentMediaState: typeof CurrentMediaState
CurrentPosition: typeof CurrentPosition
CurrentRelativeHumidity: typeof CurrentRelativeHumidity
CurrentSlatState: typeof CurrentSlatState
CurrentTemperature: typeof CurrentTemperature
CurrentTiltAngle: typeof CurrentTiltAngle
CurrentTime: typeof CurrentTime

Deprecated

Removed and not used anymore

CurrentTransport: typeof CurrentTransport
CurrentVerticalTiltAngle: typeof CurrentVerticalTiltAngle
CurrentVisibilityState: typeof CurrentVisibilityState
DataStreamHAPTransport: typeof DataStreamHAPTransport
DataStreamHAPTransportInterrupt: typeof DataStreamHAPTransportInterrupt
DayoftheWeek: typeof DayoftheWeek

Deprecated

Removed and not used anymore

DiagonalFieldOfView: typeof DiagonalFieldOfView
DigitalZoom: typeof DigitalZoom
DiscoverBridgedAccessories: typeof DiscoverBridgedAccessories

Deprecated

Removed and not used anymore

DiscoveredBridgedAccessories: typeof DiscoveredBridgedAccessories

Deprecated

Removed and not used anymore

DisplayOrder: typeof DisplayOrder
EventRetransmissionMaximum: typeof EventRetransmissionMaximum
EventSnapshotsActive: typeof EventSnapshotsActive
EventTransmissionCounters: typeof EventTransmissionCounters
FilterChangeIndication: typeof FilterChangeIndication
FilterLifeLevel: typeof FilterLifeLevel
FirmwareRevision: typeof FirmwareRevision
FirmwareUpdateReadiness: typeof FirmwareUpdateReadiness
FirmwareUpdateStatus: typeof FirmwareUpdateStatus
HardwareFinish: typeof HardwareFinish
HardwareRevision: typeof HardwareRevision
HeartBeat: typeof HeartBeat
HeatingThresholdTemperature: typeof HeatingThresholdTemperature
HoldPosition: typeof HoldPosition
HomeKitCameraActive: typeof HomeKitCameraActive
Hue: typeof Hue
Identifier: typeof Identifier
Identify: typeof Identify
ImageMirroring: typeof ImageMirroring
ImageRotation: typeof ImageRotation
InUse: typeof InUse
InputDeviceType: typeof InputDeviceType
InputSourceType: typeof InputSourceType
IsConfigured: typeof IsConfigured
LeakDetected: typeof LeakDetected
LinkQuality: typeof LinkQuality

Deprecated

Removed and not used anymore

ListPairings: typeof ListPairings
LockControlPoint: typeof LockControlPoint
LockCurrentState: typeof LockCurrentState
LockLastKnownAction: typeof LockLastKnownAction
LockManagementAutoSecurityTimeout: typeof LockManagementAutoSecurityTimeout
LockPhysicalControls: typeof LockPhysicalControls
LockTargetState: typeof LockTargetState
Logs: typeof Logs
MACRetransmissionMaximum: typeof MACRetransmissionMaximum
MACTransmissionCounters: typeof MACTransmissionCounters
ManagedNetworkEnable: typeof ManagedNetworkEnable
ManuallyDisabled: typeof ManuallyDisabled
Manufacturer: typeof Manufacturer
MaximumTransmitPower: typeof MaximumTransmitPower
MetricsBufferFullState: typeof MetricsBufferFullState
Model: typeof Model
MotionDetected: typeof MotionDetected
MultifunctionButton: typeof MultifunctionButton
Mute: typeof Mute
NFCAccessControlPoint: typeof NFCAccessControlPoint
NFCAccessSupportedConfiguration: typeof NFCAccessSupportedConfiguration
Name: typeof Name
NetworkAccessViolationControl: typeof NetworkAccessViolationControl
NetworkClientProfileControl: typeof NetworkClientProfileControl
NetworkClientStatusControl: typeof NetworkClientStatusControl
NightVision: typeof NightVision
NitrogenDioxideDensity: typeof NitrogenDioxideDensity
ObstructionDetected: typeof ObstructionDetected
OccupancyDetected: typeof OccupancyDetected
On: typeof On
OperatingStateResponse: typeof OperatingStateResponse
OpticalZoom: typeof OpticalZoom
OutletInUse: typeof OutletInUse
OzoneDensity: typeof OzoneDensity
PM10Density: typeof PM10Density
PM2_5Density: typeof PM2_5Density
PairSetup: typeof PairSetup
PairVerify: typeof PairVerify
PairingFeatures: typeof PairingFeatures
PasswordSetting: typeof PasswordSetting
PeriodicSnapshotsActive: typeof PeriodicSnapshotsActive
PictureMode: typeof PictureMode
Ping: typeof Ping
PositionState: typeof PositionState
PowerModeSelection: typeof PowerModeSelection
ProductData: typeof ProductData
ProgramMode: typeof ProgramMode
ProgrammableSwitchEvent: typeof ProgrammableSwitchEvent
ProgrammableSwitchOutputState: typeof ProgrammableSwitchOutputState
Reachable: typeof Reachable

Deprecated

Removed and not used anymore

ReceivedSignalStrengthIndication: typeof ReceivedSignalStrengthIndication
ReceiverSensitivity: typeof ReceiverSensitivity
RecordingAudioActive: typeof RecordingAudioActive
RelativeHumidityDehumidifierThreshold: typeof RelativeHumidityDehumidifierThreshold
RelativeHumidityHumidifierThreshold: typeof RelativeHumidityHumidifierThreshold
RelayControlPoint: typeof RelayControlPoint
RelayEnabled: typeof RelayEnabled
RelayState: typeof RelayState
RemainingDuration: typeof RemainingDuration
RemoteKey: typeof RemoteKey
ResetFilterIndication: typeof ResetFilterIndication
RotationDirection: typeof RotationDirection
RotationSpeed: typeof RotationSpeed
RouterStatus: typeof RouterStatus
Saturation: typeof Saturation
SecuritySystemAlarmType: typeof SecuritySystemAlarmType
SecuritySystemCurrentState: typeof SecuritySystemCurrentState
SecuritySystemTargetState: typeof SecuritySystemTargetState
SelectedAudioStreamConfiguration: typeof SelectedAudioStreamConfiguration
SelectedCameraRecordingConfiguration: typeof SelectedCameraRecordingConfiguration
SelectedDiagnosticsModes: typeof SelectedDiagnosticsModes
SelectedRTPStreamConfiguration: typeof SelectedRTPStreamConfiguration
SelectedSleepConfiguration: typeof SelectedSleepConfiguration
SerialNumber: typeof SerialNumber
ServiceLabelIndex: typeof ServiceLabelIndex
ServiceLabelNamespace: typeof ServiceLabelNamespace
SetDuration: typeof SetDuration
SetupDataStreamTransport: typeof SetupDataStreamTransport
SetupEndpoints: typeof SetupEndpoints
SetupTransferTransport: typeof SetupTransferTransport
SignalToNoiseRatio: typeof SignalToNoiseRatio
SiriEnable: typeof SiriEnable
SiriEndpointSessionStatus: typeof SiriEndpointSessionStatus
SiriEngineVersion: typeof SiriEngineVersion
SiriInputType: typeof SiriInputType
SiriLightOnUse: typeof SiriLightOnUse
SiriListening: typeof SiriListening
SiriTouchToUse: typeof SiriTouchToUse
SlatType: typeof SlatType
SleepDiscoveryMode: typeof SleepDiscoveryMode
SleepInterval: typeof SleepInterval
SmokeDetected: typeof SmokeDetected
SoftwareRevision: typeof SoftwareRevision
StagedFirmwareVersion: typeof StagedFirmwareVersion
StatusActive: typeof StatusActive
StatusFault: typeof StatusFault
StatusJammed: typeof StatusJammed
StatusLowBattery: typeof StatusLowBattery
StatusTampered: typeof StatusTampered
StreamingStatus: typeof StreamingStatus
SulphurDioxideDensity: typeof SulphurDioxideDensity
SupportedAssetTypes: typeof SupportedAssetTypes
SupportedAudioRecordingConfiguration: typeof SupportedAudioRecordingConfiguration
SupportedAudioStreamConfiguration: typeof SupportedAudioStreamConfiguration
SupportedCameraRecordingConfiguration: typeof SupportedCameraRecordingConfiguration
SupportedCharacteristicValueTransitionConfiguration: typeof SupportedCharacteristicValueTransitionConfiguration
SupportedDataStreamTransportConfiguration: typeof SupportedDataStreamTransportConfiguration
SupportedDiagnosticsModes: typeof SupportedDiagnosticsModes
SupportedDiagnosticsSnapshot: typeof SupportedDiagnosticsSnapshot
SupportedFirmwareUpdateConfiguration: typeof SupportedFirmwareUpdateConfiguration
SupportedMetrics: typeof SupportedMetrics
SupportedRTPConfiguration: typeof SupportedRTPConfiguration
SupportedRouterConfiguration: typeof SupportedRouterConfiguration
SupportedSleepConfiguration: typeof SupportedSleepConfiguration
SupportedTransferTransportConfiguration: typeof SupportedTransferTransportConfiguration
SupportedVideoRecordingConfiguration: typeof SupportedVideoRecordingConfiguration
SupportedVideoStreamConfiguration: typeof SupportedVideoStreamConfiguration
SwingMode: typeof SwingMode
TapType: typeof TapType
TargetAirPurifierState: typeof TargetAirPurifierState
TargetAirQuality: typeof TargetAirQuality

Deprecated

Removed and not used anymore

TargetControlList: typeof TargetControlList
TargetControlSupportedConfiguration: typeof TargetControlSupportedConfiguration
TargetDoorState: typeof TargetDoorState
TargetFanState: typeof TargetFanState
TargetHeaterCoolerState: typeof TargetHeaterCoolerState
TargetHeatingCoolingState: typeof TargetHeatingCoolingState
TargetHorizontalTiltAngle: typeof TargetHorizontalTiltAngle
TargetHumidifierDehumidifierState: typeof TargetHumidifierDehumidifierState
TargetMediaState: typeof TargetMediaState
TargetPosition: typeof TargetPosition
TargetRelativeHumidity: typeof TargetRelativeHumidity
TargetSlatState: typeof TargetSlatState

Deprecated

Removed and not used anymore

TargetTemperature: typeof TargetTemperature
TargetTiltAngle: typeof TargetTiltAngle
TargetVerticalTiltAngle: typeof TargetVerticalTiltAngle
TargetVisibilityState: typeof TargetVisibilityState
TemperatureDisplayUnits: typeof TemperatureDisplayUnits
ThirdPartyCameraActive: typeof ThirdPartyCameraActive
ThreadControlPoint: typeof ThreadControlPoint
ThreadNodeCapabilities: typeof ThreadNodeCapabilities
ThreadOpenThreadVersion: typeof ThreadOpenThreadVersion
ThreadStatus: typeof ThreadStatus
TimeUpdate: typeof TimeUpdate

Deprecated

Removed and not used anymore

Token: typeof Token
TransmitPower: typeof TransmitPower
TunnelConnectionTimeout: typeof TunnelConnectionTimeout
TunneledAccessoryAdvertising: typeof TunneledAccessoryAdvertising
TunneledAccessoryConnected: typeof TunneledAccessoryConnected
TunneledAccessoryStateNumber: typeof TunneledAccessoryStateNumber
VOCDensity: typeof VOCDensity
ValveType: typeof ValveType
Version: typeof Version
VideoAnalysisActive: typeof VideoAnalysisActive
Volume: typeof Volume
VolumeControlType: typeof VolumeControlType
VolumeSelector: typeof VolumeSelector
WANConfigurationList: typeof WANConfigurationList
WANStatusList: typeof WANStatusList
WakeConfiguration: typeof WakeConfiguration
WaterLevel: typeof WaterLevel
WiFiCapabilities: typeof WiFiCapabilities
WiFiConfigurationControl: typeof WiFiConfigurationControl
WiFiSatelliteStatus: typeof WiFiSatelliteStatus

Methods

  • This updates the value by calling the 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 SET event handler is called.

    Parameters

    Returns Characteristic

  • Sets the state of the characteristic to an errored state.

    If a onGet or 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 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 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.

    Parameters

    • error: Error | HapStatusError

      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 GET handlers have precedence.

    Returns Characteristic

  • This updates the value by calling the 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 SET event handler is called.

    Deprecated

    Parameter callback is deprecated.

    Parameters

    Returns Characteristic

  • This updates the value by calling the 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 SET event handler is called.

    Parameters

    Returns Characteristic

  • 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):

    • First method is to specifically list every valid value inside validValues
    • Second you can specify a range via minValue and maxValue (with optionally defining minStep)
    • And lastly you can specify a range via validValueRanges
    • Implicitly a valid value range is predefined for characteristics with Format UINT8, UINT16, UINT32 and UINT64: starting by zero to their respective maximum number

    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.

    Example

    // 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());

    Returns Iterable<number>