Home Automation blog

Skip to Content

NodeRed HomeKit Characteristics reference

Article image for NodeRed HomeKit Characteristics reference

Posted by Chris

Date posted:

NodeRed's HomeKit package has a distinct lack of documentation and/or examples which I found to be a bit of a roadblock. This post aims to remedy the situation. What follows is a list of Services and Characteristics that can (and how to) be implemented.

Characteristics

Legend:

  • Default: Default value.
  • Max: Maximum value.
  • Min: Minimum value.
  • Valid: Valid values of characteristic.
  • Read only: True: Output characteristic of Homekit node only, False: Input/Output characteristic of Homekit node.
  • Notify: Triggers output from a Homekit node.

AirQuality

Default Max Min Valid Read only Notify
0 5 0 0,1,2,3,4,5
(unknown, excellent, good, fair, inferior, poor)
false true

Active

Default Max Min Valid Read only Notify
0 1 0 0, 1
(active, inactive)
false true

BatteryLevel

Default Max Min Valid Read only Notify
0 100 0 0-100 true true

Brightness

Default Max Min Valid Read only Notify
0 100 0 0-100 false true

CarbonDioxideDetected

Default Max Min Valid Read only Notify
0 1 0 0,1
(levels normal, levels abnormal)
   

CarbonDioxideLevel

Default Max Min Valid Read only Notify
0.0 10000 0 0-10000 false true

CarbonDioxidePeakLevel

Default Max Min Valid Read only Notify
0.0 10000 0 0-10000 false true

CarbonMonoxideDetected

Default Max Min Valid Read only Notify
0 1 0 0,1
(levels normal, levels abnormal)
true true

CarbonMonoxideLevel

Default Max Min Valid Read only Notify
0.0 100 0 0-100 false true

CarbonMonoxidePeakLevel

Default Max Min Valid Read only Notify
0.0 100 0 0-100 false true

ChargingState

Default Max Min Valid Read only Notify
0 2 0 0,1,2
(not charging, charging, not chargable)
false true

ColorTemperature

Default Max Min Valid Read only Notify
140 15000 140 140-15000 false true

ContactSensorState

Default Max Min Valid Read only Notify
0 1 0 0,1
(contact detected, contact not dectected)
false true

CoolingThresholdTemperature

Default Max Min Valid Read only Notify
0.0 38 10 10-38 false true

CurrentAirPurifierState

Default Max Min Valid Read only Notify
0 2 0 0,1,2
(inactive, idle, purify air)
true true

CurrentAmbientLightLevel

Default Max Min Valid Read only Notify
0.0 100 0.0001 0-100 true true

CurrentDoorState

Default Max Min Valid Read only Notify
0 4 0 0,1,2,3,4
(open, closed, opening, closing, stopped)
   

CurrentFanState

Default Max Min Valid Read only Notify
0 2 0 0,1,2
(inactive, idle, blowing air)
true true

CurrentHeaterCoolerState

Default Max Min Valid Read only Notify
1 3 0 0,1,2,3
(inactive, idle, heating, cooling)
true true

CurrentHeatingCoolingState

Default Max Min Valid Read only Notify
0 2 0 0,1,2
(off, heat, cool)
true true

CurrentHorizontalTiltAngle

Default Max Min Valid Read only Notify
0 90 -90 -90 to 90 true true

CurrentHumidifierDehumidifierState

Default Max Min Valid Read only Notify
0 3 0 0,1,2,3
(inactive, idle, humidifying, dehumidifying)
true true

CurrentPosition

Default Max Min Valid Read only Notify
0 100 0 0-100 true true

CurrentRelativeHumidity

Default Max Min Valid Read only Notify
0.0 100 0 0-100 true true

CurrentSlatState

Default Max Min Valid Read only Notify
0 2 0 0,1,2
(fixed, jammed, swinging)
false true

CurrentTemperature

Default Max Min Valid Read only Notify
0.0/td> 500 -100 -100 to 500 true true

CurrentVerticalTiltAngle

Default Max Min Valid Read only Notify
0 90 -90 -90 to 90 true true

FilterChangeIndication

Default Max Min Valid Read only Notify
0 1 0 0,1
(filter OK, change filter)
false true

FilterLifeLevel

Default Max Min Valid Read only Notify
0.0 100 0 0-100 true true

HeatingThresholdTemperature

Default Max Min Valid Read only Notify
0.0 38 0 0-38 false true

HoldPosition

Default Max Min Valid Read only Notify
true true false true, false true false

Hue

Default Max Min Valid Read only Notify
0.0 360.0 0.0 0-360 false true

InUse

Default Max Min Valid Read only Notify
0 1 0 0,1
(not in use, in use)
true true

IsConfigured

Default Max Min Valid Read only Notify
0 1 0 0,1
(not configured, is configured)
false true

LeakDetected

Default Max Min Valid Read only Notify
0 1 0 0,1
(leak not detected, leak detected)
false true

LockCurrentState

Default Max Min Valid Read only Notify
0 3 0 0,1,2,3
(unsecured, secured, jammed, unknown)
true true

LockPhysicalControls

Default Max Min Valid Read only Notify
0 1 0 0,1
(lock disabled, lock enabled)
false true

LockTargetState

Default Max Min Valid Read only Notify
0 1 0 0,1
(unsecured, secured)
false true

MediaItemAlbumName

Default Read only Notify
  true true

MediaItemArtist

Default Read only Notify
  true true

MediaItemName

Default Read only Notify
  true true

MotionDetected

Default Max Min Valid Read only Notify
false true false true,false true false

Mute

Default Max Min Valid Read only Notify
false true false true,false false false

Name

Default Read only Notify
  false false

NitrogenDioxideDensity

Default Max Min Valid Read only Notify
0.0 1000.0 0.0 0-1000 true true

ObstructionDetected

Default Max Min Valid Read only Notify
false true false true,false true false

OccupancyDetected

Default Max Min Valid Read only Notify
false true false true,false true false

On

Default Max Min Valid Read only Notify
false true false true,false false false

OutletInUse

Default Max Min Valid Read only Notify
false true false true,false true true

OzoneDensity

Default Max Min Valid Read only Notify
false true false true,false true true

PM10Density

Default Max Min Valid Read only Notify
0.0 1000.0 0.0 0-1000 true true

PM2_5Density

Default Max Min Valid Read only Notify
0.0 1000.0 0.0 0-1000 true true

PlaybackState

Default Max Min Valid Read only Notify
2 2 0 0,1,2
(playing, paused, stopped)
false true

PositionState

Default Max Min Valid Read only Notify
2 2 0 0,1,2
(decreasing, increasing, stopped)
true true

ProgramMode

Default Max Min Valid Read only Notify
0 2 0 0,1,2
(no program scheduled, program scheduled, manual mode)
true true

ProgrammableSwitchEvent

Default Max Min Valid Read only Notify
2 2 0 0,1,2
(single press, double press, long press)
true true

RelativeHumidityDehumidifierThreshold

Default Max Min Valid Read only Notify
0.0 100.0 0.0 0-100 false true

RelativeHumidityHumidifierThreshold

Default Max Min Valid Read only Notify
0.0 100.0 0.0 0-100 false true

RemainingDuration

Default Max Min Valid Read only Notify
0 43200 0 0-43200 true true

ResetFilterIndication

Default Max Min Valid Read only Notify
1 1 1 1
(reset filter indication)
false true

RotationDirection

Default Max Min Valid Read only Notify
0 1 0 0,1
(clockwise, counter clockwise)
false true

RotationSpeed

Default Max Min Valid Read only Notify
0.0 100 0.0 0-100 false true

Saturation

Default Max Min Valid Read only Notify
0.0 100.0 0.0 0-100 false true

SecuritySystemAlarmType

Default Max Min Valid Read only Notify
0 1 0 0,1
(no alarm, alarm)
true true

SecuritySystemCurrentState

Default Max Min Valid Read only Notify
0 4 0 0,1,2,3,4
(stay armed, away armed, night armed, disarmed, alarm triggered)
true true

SecuritySystemTargetState

Default Max Min Valid Read only Notify
0 4 0 0,1,2,3,4
(stay arm, away arm, night arm, disarm)
false true

SelectedRTPStreamConfiguration

Default Read only Notify
  true false

ServiceLabelIndex

Default Max Min Valid Read only Notify
1 255 1 1-255 false false

SetDuration

Default Max Min Valid Read only Notify
0 43200 0 0-43200 false true

SetupEndpoints

Default Read only Notify
  true true

SlatType

Default Max Min Valid Read only Notify
0 1 0 0,1
(horizontal, vertical)
true true

SmokeDetected

Default Max Min Valid Read only Notify
0 1 0 0,1
(smoke not detected, smoke detected)
false true

StatusActive

Default Max Min Valid Read only Notify
true true false true,false true false

StatusFault

Default Max Min Valid Read only Notify
0 1 0 0,1
(no fault, fault)
true false

StatusLowBattery

Default Max Min Valid Read only Notify
0 1 0 0,1
(normal, low)
true true

StatusTampered

Default Max Min Valid Read only Notify
0 1 0 0,1
(not tampered, tampered)
true true

StreamingStatus

Default Read only Notify
  true true

SulphurDioxideDensity

Default Max Min Valid Read only Notify
0.0 1000.0 0.0 0-1000 true true

SupportedAudioStreamConfiguration

Default Read only Notify
  true false

SupportedRTPConfiguration

Default Read only Notify
  true false

SupportedVideoStreamConfiguration

Default Read only Notify
  true false

SwingMode

Default Max Min Valid Read only Notify
0 1 0 0,1
(disabled, enabled)
false true

TargetAirPurifierState

Default Max Min Valid Read only Notify
0 1 0 0,1
(manual, auto)
false true

TargetDoorState

Default Max Min Valid Read only Notify
0 1 0 0,1
(open, closed)
false true

TargetFanState

Default Max Min Valid Read only Notify
0 1 0 0,1
(manual, auto)
false true

TargetHeaterCoolerState

Default Max Min Valid Read only Notify
1 2 0 0,1,2
(auto, heat, cool)
true true

TargetHeatingCoolingState

Default Max Min Valid Read only Notify
0 3 0 0,1,2,3
(off, heat, cool, auto)
false true

TargetHorizontalTiltAngle

Default Max Min Valid Read only Notify
0 90 -90 -90 to 90 false true

TargetHumidifierDehumidifierState

Default Max Min Valid Read only Notify
0 2 0 0,1,2
(humidifier or dehumidifier, humidifier, dehumidifier)
false true

TargetPosition

Default Max Min Valid Read only Notify
0 100 0 0-100 false true

TargetRelativeHumidity

Default Max Min Valid Read only Notify
0.0 100.0 0.0 0-100 false true

TargetTemperature

Default Max Min Valid Read only Notify
0.0 38 10 10-38 false true

TargetTiltAngle

Default Max Min Valid Read only Notify
0 90 -90 -90 to 90 false true

TargetVerticalTiltAngle

Default Max Min Valid Read only Notify
0 90 -90 -90 to 90 false true

TemperatureDisplayUnits

Default Max Min Valid Read only Notify
0 1 0 0,1
(celsius, fahrenheit)
false true

VOCDensity

Default Max Min Valid Read only Notify
0.0 1000.0 0.0 0-1000 true true

ValveType

Default Max Min Valid Read only Notify
0 3 0 0,1,2,3
(generic, irrigation, shower head, water faucet)
true true

Volume

Default Max Min Valid Read only Notify
0 100 0 0-100 false true

WaterLevel

Default Max Min Valid Read only Notify
0.0 100.0 0.0 0-100 true true