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. See examples.

Characteristics


Legend:

  • Type: Variable type.
  • Default: Default value.
  • Max: Maximum value.
  • Min: Minimum value.
  • Valid: Valid values of characteristic.

AirQuality

Type Default Max Min Valid
INT 0 5 0 0,1,2,3,4,5
(unknown, excellent, good, fair, inferior, poor)

Active

Type Default Max Min Valid
INT 0 1 0 0, 1
(inactive, active)

BatteryLevel

Type Default Max Min Valid
INT 0 100 0 0-100

Brightness

Type Default Max Min Valid
INT 0 100 0 0-100

CarbonDioxideDetected

Type Default Max Min Valid
INT 0 1 0 0,1
(levels normal, levels abnormal)

CarbonDioxideLevel

Type Default Max Min Valid
FLOAT 0.0 10000 0 0-10000

CarbonDioxidePeakLevel

Type Default Max Min Valid
FLOAT 0.0 10000 0 0-10000

CarbonMonoxideDetected

Type Default Max Min Valid
INT 0 1 0 0,1
(levels normal, levels abnormal)

CarbonMonoxideLevel

Type Default Max Min Valid
FLOAT 0.0 100 0 0-100

CarbonMonoxidePeakLevel

Type Default Max Min Valid
FLOAT 0.0 100 0 0-100

ChargingState

Type Default Max Min Valid
INT 0 2 0 0,1,2
(not charging, charging, not chargable)

ColorTemperature

Type Default Max Min Valid
INT 140 15000 140 140-15000

ContactSensorState

Type Default Max Min Valid
INT 0 1 0 0,1
(contact detected, contact not dectected)

CoolingThresholdTemperature

Type Default Max Min Valid
FLOAT 0.0 38 10 10-38

CurrentAirPurifierState

Type Default Max Min Valid
INT 0 2 0 0,1,2
(inactive, idle, purify air)

CurrentAmbientLightLevel

Type Default Max Min Valid
FLOAT 0.0 100 0.0001 0-100

CurrentDoorState

Type Default Max Min Valid
INT 0 4 0 0,1,2,3,4
(open, closed, opening, closing, stopped)

CurrentFanState

Type Default Max Min Valid
INT 0 2 0 0,1,2
(inactive, idle, blowing air)

CurrentHeaterCoolerState

Type Default Max Min Valid
INT 1 3 0 0,1,2,3
(inactive, idle, heating, cooling)

CurrentHeatingCoolingState

Type Default Max Min Valid
INT 0 2 0 0,1,2
(off, heat, cool)

CurrentHorizontalTiltAngle

Type Default Max Min Valid
INT 0 90 -90 -90 to 90

CurrentHumidifierDehumidifierState

Type Default Max Min Valid
INT 0 3 0 0,1,2,3
(inactive, idle, humidifying, dehumidifying)

CurrentPosition

Type Default Max Min Valid
INT 0 100 0 0-100

CurrentRelativeHumidity

Type Default Max Min Valid
FLOAT 0.0 100 0 0-100

CurrentSlatState

Type Default Max Min Valid
INT 0 2 0 0,1,2
(fixed, jammed, swinging)

CurrentTemperature

Type Default Max Min Valid
FLOAT 0.0 500 -100 -100 to 500

CurrentVerticalTiltAngle

Type Default Max Min Valid
INT 0 90 -90 -90 to 90

FilterChangeIndication

Type Default Max Min Valid
INT 0 1 0 0,1
(filter OK, change filter)

FilterLifeLevel

Type Default Max Min Valid
FLOAT 0.0 100 0 0-100

HeatingThresholdTemperature

Type Default Max Min Valid
FLOAT 0.0 38 0 0-38

HoldPosition

Type Default Max Min Valid
BOOL true true false true, false

Hue

Type Default Max Min Valid
FLOAT 0.0 360.0 0.0 0-360

InUse

Type Default Max Min Valid
INT 0 1 0 0,1
(not in use, in use)

IsConfigured

Type Default Max Min Valid
INT 0 1 0 0,1
(not configured, is configured)

LeakDetected

Type Default Max Min Valid
INT 0 1 0 0,1
(leak not detected, leak detected)

LockCurrentState

Type Default Max Min Valid
INT 0 3 0 0,1,2,3
(unsecured, secured, jammed, unknown)

LockPhysicalControls

Type Default Max Min Valid
INT 0 1 0 0,1
(lock disabled, lock enabled)

LockTargetState

Type Default Max Min Valid
INT 0 1 0 0,1
(unsecured, secured)

MotionDetected

Type Default Max Min Valid
BOOL false true false true,false

Mute

Type Default Max Min Valid
BOOL false true false true,false

Name

Type Default
STRING  

NitrogenDioxideDensity

Type Default Max Min Valid
FLOAT 0.0 1000.0 0.0 0-1000

ObstructionDetected

Type Default Max Min Valid
BOOL false true false true,false

OccupancyDetected

Type Default Max Min Valid
BOOL false true false true,false

On

Type Default Max Min Valid
BOOL false true false true,false

OutletInUse

Type Default Max Min Valid
BOOL false true false true,false

OzoneDensity

Type Default Max Min Valid
BOOL false true false true,false

PM10Density

Type Default Max Min Valid
FLOAT 0.0 1000.0 0.0 0-1000

PM2_5Density

Type Default Max Min Valid
FLOAT 0.0 1000.0 0.0 0-1000

PositionState

Type Default Max Min Valid
INT 2 2 0 0,1,2
(decreasing, increasing, stopped)

ProgramMode

Type Default Max Min Valid
INT 0 2 0 0,1,2
(no program scheduled, program scheduled, manual mode)

ProgrammableSwitchEvent

Type Default Max Min Valid
INT 2 2 0 0,1,2
(single press, double press, long press)

RelativeHumidityDehumidifierThreshold

Type Default Max Min Valid
FLOAT 0.0 100.0 0.0 0-100

RelativeHumidityHumidifierThreshold

Type Default Max Min Valid
FLOAT 0.0 100.0 0.0 0-100

RemainingDuration

Type Default Max Min Valid
INT 0 43200 0 0-43200

ResetFilterIndication

Type Default Max Min Valid
INT 1 1 1 1
(reset filter indication)

RotationDirection

Type Default Max Min Valid
INT 0 1 0 0,1
(clockwise, counter clockwise)

RotationSpeed

Type Default Max Min Valid
FLOAT 0.0 100 0.0 0-100

Saturation

Type Default Max Min Valid
FLOAT 0.0 100.0 0.0 0-100

SecuritySystemAlarmType

Type Default Max Min Valid
INT 0 1 0 0,1
(no alarm, alarm)

SecuritySystemCurrentState

Type Default Max Min Valid
INT 0 4 0 0,1,2,3,4
(stay armed, away armed, night armed, disarmed, alarm triggered)

SecuritySystemTargetState

Type Default Max Min Valid
INT 0 4 0 0,1,2,3,4
(stay arm, away arm, night arm, disarm)

SelectedRTPStreamConfiguration

Type Default
tlv8  

ServiceLabelIndex

Type Default Max Min Valid
INT 1 255 1 1-255

SetDuration

Type Default Max Min Valid
INT 0 43200 0 0-43200

SetupEndpoints

Type Default
tlv8  

SlatType

Type Default Max Min Valid
INT 0 1 0 0,1
(horizontal, vertical)

SmokeDetected

Type Default Max Min Valid
INT 0 1 0 0,1
(smoke not detected, smoke detected)

StatusActive

Type Default Max Min Valid
BOOL true true false true,false

StatusFault

Type Default Max Min Valid
INT 0 1 0 0,1
(no fault, fault)

StatusLowBattery

Type Default Max Min Valid
INT 0 1 0 0,1
(normal, low)

StatusTampered

Type Default Max Min Valid
INT 0 1 0 0,1
(not tampered, tampered)

StreamingStatus

Type Default
tlv8  

SulphurDioxideDensity

Type Default Max Min Valid
FLOAT 0.0 1000.0 0.0 0-1000

SupportedAudioStreamConfiguration

Type Default
tlv8  

SupportedRTPConfiguration

Type Default
tlv8  

SupportedVideoStreamConfiguration

Type Default
tlv8  

SwingMode

Type Default Max Min Valid
INT 0 1 0 0,1
(disabled, enabled)

TargetAirPurifierState

Type Default Max Min Valid
INT 0 1 0 0,1
(manual, auto)

TargetDoorState

Type Default Max Min Valid
INT 0 1 0 0,1
(open, closed)

TargetFanState

Type Default Max Min Valid
INT 0 1 0 0,1
(manual, auto)

TargetHeaterCoolerState

Type Default Max Min Valid
INT 1 2 0 0,1,2
(auto, heat, cool)

TargetHeatingCoolingState

Type Default Max Min Valid
INT 0 3 0 0,1,2,3
(off, heat, cool, auto)

TargetHorizontalTiltAngle

Type Default Max Min Valid
INT 0 90 -90 -90 to 90

TargetHumidifierDehumidifierState

Type Default Max Min Valid
INT 0 2 0 0,1,2
(humidifier or dehumidifier, humidifier, dehumidifier)

TargetPosition

Type Default Max Min Valid
INT 0 100 0 0-100

TargetRelativeHumidity

Type Default Max Min Valid
FLOAT 0.0 100.0 0.0 0-100

TargetTemperature

Type Default Max Min Valid
FLOAT 0.0 38 10 10-38

TargetTiltAngle

Type Default Max Min Valid
INT 0 90 -90 -90 to 90

TargetVerticalTiltAngle

Type Default Max Min Valid
INT 0 90 -90 -90 to 90

TemperatureDisplayUnits

Type Default Max Min Valid
INT 0 1 0 0,1
(celsius, fahrenheit)

VOCDensity

Type Default Max Min Valid
FLOAT 0.0 1000.0 0.0 0-1000

ValveType

Type Default Max Min Valid
INT 0 3 0 0,1,2,3
(generic, irrigation, shower head, water faucet)

Volume

Type Default Max Min Valid
INT 0 100 0 0-100

WaterLevel

Type Default Max Min Valid
INT 0.0 100.0 0.0 0-100

View similar posts categorised as: Node RED HomeKit