Preparing search index...
The search index is not available
hap-nodejs
hap-nodejs
CharacteristicSetCallback
Type Alias CharacteristicSetCallback
CharacteristicSetCallback
:
(
error
?:
HAPStatus
|
null
|
Error
,
writeResponse
?:
Nullable
<
CharacteristicValue
>
,
)
=>
void
Type declaration
(
error
?:
HAPStatus
|
null
|
Error
,
writeResponse
?:
Nullable
<
CharacteristicValue
>
,
)
:
void
Parameters
Optional
error
:
HAPStatus
|
null
|
Error
Optional
writeResponse
:
Nullable
<
CharacteristicValue
>
Returns
void
Settings
Member Visibility
Inherited
Theme
OS
Light
Dark
hap-nodejs
_definitions
Characteristics
AccessCodeControlPoint
AccessCodeSupportedConfiguration
AccessControlLevel
AccessoryFlags
AccessoryIdentifier
Active
ActiveIdentifier
ActivityInterval
AdministratorOnlyAccess
AirParticulateDensity
AirParticulateSize
AirPlayEnable
AirQuality
AppMatchingIdentifier
AssetUpdateReadiness
AudioFeedback
BatteryLevel
Brightness
ButtonEvent
CameraOperatingModeIndicator
CarbonDioxideDetected
CarbonDioxideLevel
CarbonDioxidePeakLevel
CarbonMonoxideDetected
CarbonMonoxideLevel
CarbonMonoxidePeakLevel
CCAEnergyDetectThreshold
CCASignalDetectThreshold
CharacteristicValueActiveTransitionCount
CharacteristicValueTransitionControl
ChargingState
ClosedCaptions
ColorTemperature
ConfigurationState
ConfiguredName
ContactSensorState
CoolingThresholdTemperature
CryptoHash
CurrentAirPurifierState
CurrentAmbientLightLevel
CurrentDoorState
CurrentFanState
CurrentHeaterCoolerState
CurrentHeatingCoolingState
CurrentHorizontalTiltAngle
CurrentHumidifierDehumidifierState
CurrentMediaState
CurrentPosition
CurrentRelativeHumidity
CurrentSlatState
CurrentTemperature
CurrentTiltAngle
CurrentTransport
CurrentVerticalTiltAngle
CurrentVisibilityState
DataStreamHAPTransport
DataStreamHAPTransportInterrupt
DiagonalFieldOfView
DigitalZoom
DisplayOrder
EventRetransmissionMaximum
EventSnapshotsActive
EventTransmissionCounters
FilterChangeIndication
FilterLifeLevel
FirmwareRevision
FirmwareUpdateReadiness
FirmwareUpdateStatus
HardwareFinish
HardwareRevision
HeartBeat
HeatingThresholdTemperature
HoldPosition
HomeKitCameraActive
Hue
Identifier
Identify
ImageMirroring
ImageRotation
InputDeviceType
InputSourceType
InUse
IsConfigured
LeakDetected
ListPairings
LockControlPoint
LockCurrentState
LockLastKnownAction
LockManagementAutoSecurityTimeout
LockPhysicalControls
LockTargetState
Logs
MACRetransmissionMaximum
MACTransmissionCounters
ManagedNetworkEnable
ManuallyDisabled
Manufacturer
MaximumTransmitPower
MetricsBufferFullState
Model
MotionDetected
MultifunctionButton
Mute
Name
NetworkAccessViolationControl
NetworkClientProfileControl
NetworkClientStatusControl
NFCAccessControlPoint
NFCAccessSupportedConfiguration
NightVision
NitrogenDioxideDensity
ObstructionDetected
OccupancyDetected
On
OperatingStateResponse
OpticalZoom
OutletInUse
OzoneDensity
PairingFeatures
PairSetup
PairVerify
PasswordSetting
PeriodicSnapshotsActive
PictureMode
Ping
PM10Density
PM2_5Density
PositionState
PowerModeSelection
ProductData
ProgrammableSwitchEvent
ProgrammableSwitchOutputState
ProgramMode
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
SupportedRouterConfiguration
SupportedRTPConfiguration
SupportedSleepConfiguration
SupportedTransferTransportConfiguration
SupportedVideoRecordingConfiguration
SupportedVideoStreamConfiguration
SwingMode
TapType
TargetAirPurifierState
TargetControlList
TargetControlSupportedConfiguration
TargetDoorState
TargetFanState
TargetHeaterCoolerState
TargetHeatingCoolingState
TargetHorizontalTiltAngle
TargetHumidifierDehumidifierState
TargetMediaState
TargetPosition
TargetRelativeHumidity
TargetTemperature
TargetTiltAngle
TargetVerticalTiltAngle
TargetVisibilityState
TemperatureDisplayUnits
ThirdPartyCameraActive
ThreadControlPoint
ThreadNodeCapabilities
ThreadOpenThreadVersion
ThreadStatus
Token
TransmitPower
TunnelConnectionTimeout
TunneledAccessoryAdvertising
TunneledAccessoryConnected
TunneledAccessoryStateNumber
ValveType
Version
VideoAnalysisActive
VOCDensity
Volume
VolumeControlType
VolumeSelector
WakeConfiguration
WANConfigurationList
WANStatusList
WaterLevel
WiFiCapabilities
WiFiConfigurationControl
WiFiSatelliteStatus
Services
AccessCode
AccessControl
AccessoryInformation
AccessoryMetrics
AccessoryRuntimeInformation
AirPurifier
AirQualitySensor
AssetUpdate
Assistant
AudioStreamManagement
Battery
CameraOperatingMode
CameraRecordingManagement
CameraRTPStreamManagement
CarbonDioxideSensor
CarbonMonoxideSensor
CloudRelay
ContactSensor
DataStreamTransportManagement
Diagnostics
Door
Doorbell
Fan
Fanv2
Faucet
FilterMaintenance
FirmwareUpdate
GarageDoorOpener
HeaterCooler
HumidifierDehumidifier
HumiditySensor
InputSource
IrrigationSystem
LeakSensor
Lightbulb
LightSensor
LockManagement
LockMechanism
Microphone
MotionSensor
NFCAccess
OccupancySensor
Outlet
Pairing
PowerManagement
ProtocolInformation
SecuritySystem
ServiceLabel
Siri
SiriEndpoint
Slats
SmartSpeaker
SmokeSensor
Speaker
StatefulProgrammableSwitch
StatelessProgrammableSwitch
Switch
TapManagement
TargetControl
TargetControlManagement
Television
TelevisionSpeaker
TemperatureSensor
Thermostat
ThreadTransport
TransferTransportManagement
Tunnel
Valve
WiFiRouter
WiFiSatellite
WiFiTransport
Window
WindowCovering
LegacyTypes
ACCESSORY_INFORMATION_STYPE
ADMIN_ONLY_ACCESS_CTYPE
ALARM_CURRENT_STATE_CTYPE
ALARM_STYPE
ALARM_SYSTEM_TCTYPE
ALARM_TARGET_STATE_CTYPE
AUDIO_FEEDBACK_CTYPE
BATTERY_LEVEL_CTYPE
BRIGHTNESS_CTYPE
CONTACT_SENSOR_STATE_CTYPE
CONTACT_SENSOR_STYPE
COOLING_THRESHOLD_CTYPE
CURRENT_DOOR_STATE_CTYPE
CURRENT_LOCK_MECHANISM_STATE_CTYPE
CURRENT_RELATIVE_HUMIDITY_CTYPE
CURRENT_TEMPERATURE_CTYPE
CURRENTHEATINGCOOLING_CTYPE
DOOR_LOCK_TCTYPE
DOOR_TCTYPE
FAN_STYPE
FAN_TCTYPE
FIRMWARE_REVISION_CTYPE
GARAGE_DOOR_OPENER_STYPE
GARAGE_DOOR_OPENER_TCTYPE
HEATING_THRESHOLD_CTYPE
HUE_CTYPE
HUMIDITY_SENSOR_STYPE
IDENTIFY_CTYPE
LIGHTBULB_STYPE
LIGHTBULB_TCTYPE
LOCK_MANAGEMENT_AUTO_SECURE_TIMEOUT_CTYPE
LOCK_MANAGEMENT_CONTROL_POINT_CTYPE
LOCK_MANAGEMENT_STYPE
LOCK_MECHANISM_LAST_KNOWN_ACTION_CTYPE
LOCK_MECHANISM_STYPE
LOGS_CTYPE
MANUFACTURER_CTYPE
MODEL_CTYPE
MOTION_DETECTED_CTYPE
MOTION_SENSOR_STYPE
NAME_CTYPE
OBSTRUCTION_DETECTED_CTYPE
OCCUPANCY_DETECTED_CTYPE
OCCUPANCY_SENSOR_STYPE
OTHER_TCTYPE
OUTLET_IN_USE_CTYPE
OUTLET_STYPE
OUTLET_TCTYPE
POWER_STATE_CTYPE
PROGRAMMABLE_SWITCH_OUTPUT_STATE_CTYPE
PROGRAMMABLE_SWITCH_SWITCH_EVENT_CTYPE
PROGRAMMABLE_SWITCH_TCTYPE
ROTATION_DIRECTION_CTYPE
ROTATION_SPEED_CTYPE
SATURATION_CTYPE
SENSOR_TCTYPE
SERIAL_NUMBER_CTYPE
STATUS_FAULT_CTYPE
STATUS_LOW_BATTERY_CTYPE
SWITCH_STYPE
SWITCH_TCTYPE
TARGET_DOORSTATE_CTYPE
TARGET_LOCK_MECHANISM_STATE_CTYPE
TARGET_RELATIVE_HUMIDITY_CTYPE
TARGET_TEMPERATURE_CTYPE
TARGETHEATINGCOOLING_CTYPE
TEMPERATURE_SENSOR_STYPE
TEMPERATURE_UNITS_CTYPE
THERMOSTAT_STYPE
THERMOSTAT_TCTYPE
VERSION_CTYPE
WINDOW_COVERING_CURRENT_POSITION_CTYPE
WINDOW_COVERING_OPERATION_STATE_CTYPE
WINDOW_COVERING_STYPE
WINDOW_COVERING_TARGET_POSITION_CTYPE
WINDOW_COVERING_TCTYPE
WINDOW_TCTYPE
uuid
Binary
BinaryLike
BASE_UUID
generate
isValid
toLongForm
toShortForm
unparse
write
Access
AccessControlEvent
AccessLevel
AccessoryEventTypes
AdaptiveLightingControllerEvents
AdaptiveLightingControllerMode
AudioBitrate
AudioCodecTypes
AudioRecordingCodecType
AudioRecordingSamplerate
AudioSamplerate
AudioStreamingCodecType
AudioStreamingSamplerate
ButtonState
ButtonType
CameraControllerEvents
Categories
ChangeReason
CharacteristicEventTypes
CharacteristicWarningType
DataFormatTags
DataStreamConnectionEvent
DataStreamServerEvent
DataStreamStatus
DefaultControllerType
EventedHTTPServerEvent
EventTriggerOption
Formats
H264Level
H264Profile
HAPConnectionEvent
HAPHTTPCode
HAPPairingHTTPCode
HAPServerEventTypes
HAPStatus
HDSConnectionErrorType
HDSProtocolSpecificErrorReason
HDSStatus
MDNSAdvertiser
MediaContainerType
MessageType
PacketDataType
PermissionTypes
Perms
Protocols
RemoteControllerEvents
ResourceRequestReason
ResourceRequestType
ServiceEventTypes
SiriAudioSessionEvents
SRTPCryptoSuites
StreamRequestTypes
TargetCategory
TargetUpdates
TLVErrorCode
Topics
Units
VideoCodecPacketizationMode
VideoCodecType
AccessControlManagement
Accessory
AccessoryInfo
AdaptiveLightingController
Bridge
CameraController
Characteristic
ColorUtils
DataStreamConnection
DataStreamManagement
DataStreamParser
DataStreamReader
DataStreamServer
DataStreamWriter
DoorbellController
EventedHTTPServer
Float32
Float64
HAPConnection
HAPEncryption
HAPServer
HapStatusError
HAPStorage
HDSConnectionError
HDSProtocolError
Int16
Int32
Int64
Int8
RecordingManagement
RemoteController
RTPStreamManagement
SecondsSince2001
Service
SiriAudioSession
UUID
ValueWrapper
AccessoriesResponse
AccessoryJsonObject
ActiveAdaptiveLightingTransition
AdaptiveLightingControllerUpdate
AdaptiveLightingOptions
AdaptiveLightingTransitionCurveEntry
AdaptiveLightingTransitionPoint
BrightnessAdjustmentMultiplierRange
CameraControllerOptions
CameraControllerServiceMap
CameraControllerState
CameraRecordingConfiguration
CameraRecordingDelegate
CameraRecordingOptions
CameraStreamingDelegate
CameraStreamingOptionsBase
CameraStreamingOptionsLegacySRTP
CameraStreamingOptionsSupportedCryptoSuites
CharacteristicId
CharacteristicJsonObject
CharacteristicOperationContext
CharacteristicProps
CharacteristicReadDataValue
CharacteristicReadError
CharacteristicsReadRequest
CharacteristicsReadResponse
CharacteristicsWriteRequest
CharacteristicsWriteResponse
CharacteristicWarning
CharacteristicWrite
CharacteristicWriteDataValue
CharacteristicWriteError
Controller
ControllerConstructor
ControllerContext
ControllerServiceMap
DataStreamProtocolHandler
DoorbellOptions
H264CodecParameters
MediaContainerConfiguration
PairingInformation
PartialCharacteristicReadDataValue
PartialCharacteristicReadError
PartialCharacteristicWriteDataValue
PartialCharacteristicWriteError
ProxiedSourceResponse
PublishInfo
RecordingManagementServices
RecordingManagementState
RecordingPacket
RemoteControllerServiceMap
ResourceRequest
RTPProxyOptions
RTPStreamManagementState
SelectedH264CodecParameters
SerializableController
SerializedAccessory
SerializedAdaptiveLightingControllerState
SerializedCharacteristic
SerializedControllerContext
SerializedControllerState
SerializedService
ServiceConfigurationChange
ServiceJsonObject
SiriAudioStreamProducer
SiriAudioStreamProducerConstructor
SourceResponse
VideoRecordingOptions
AccessoriesCallback
AccessoryCharacteristicChange
AdditionalAuthorizationHandler
AddPairingCallback
AudioCodecConfiguration
AudioCodecParameters
AudioFrame
AudioInfo
AudioRecordingCodec
AudioRecordingOptions
AudioStreamingCodec
AudioStreamingOptions
ButtonConfiguration
CameraStreamingOptions
CharacteristicChange
CharacteristicContext
CharacteristicGetCallback
CharacteristicGetHandler
CharacteristicReadData
CharacteristicSetCallback
CharacteristicSetHandler
CharacteristicValue
CharacteristicWriteData
ConstructorArgs
ControllerIdentifier
ControllerType
DataStreamMessage
ErrorHandler
EventHandler
EventName
FrameHandler
GlobalEventHandler
GlobalRequestHandler
HAPHttpError
HAPPincode
HAPUsername
HDSFrame
IdentificationCallback
IdentifyCallback
InterfaceName
IPAddress
IPv4Address
IPv6Address
ListPairingsCallback
MacAddress
NodeCallback
Nullable
PairCallback
PairingsCallback
PartialAllowingNull
PartialCharacteristicReadData
PartialCharacteristicWriteData
PreparedDataStreamSession
PrepareSessionCallback
PrepareStreamCallback
PrepareStreamRequest
PrepareStreamResponse
PrepareWriteRequest
PrimitiveTypes
ReadCharacteristicsCallback
ReconfiguredVideoInfo
ReconfigureStreamRequest
RemovePairingCallback
RequestHandler
Resolution
ResourceRequestCallback
ResponseHandler
RTPTime
SerializedServiceMap
ServiceCharacteristicChange
ServiceId
SessionIdentifier
SnapshotRequest
SnapshotRequestCallback
Source
StartStreamRequest
StateChangeDelegate
StopStreamRequest
StreamingRequest
StreamRequestCallback
StreamSessionIdentifier
SupportedButtonConfiguration
SupportedConfiguration
TargetConfiguration
TLVEncodable
VideoInfo
VideoStreamingOptions
VoidCallback
WithUUID
WriteCharacteristicsCallback
clone
decode
decodeList
decodeWithLists
encode
epochMillisFromMillisSince2001_01_01
epochMillisFromMillisSince2001_01_01Buffer
HAPLibraryVersion
IsKnownHAPStatusError
isSerializableController
once
readUInt16
readUInt32
readUInt64LE
readVariableUIntLE
writeFloat32LE
writeUInt16
writeUInt32
writeVariableUIntLE
M
M
N
E
P
V
F
C
I
C
P
M
F
P
C
P
T
T
A
A
A
T
R