HomeKitお役立ちリファレンス

HMAccessoryCategory.categoryType一覧

表. categoryType一覧

HMAccessoryCategoryType〜	説明
Other	その他
SecuritySystem	セキュリティシステム
Bridge	ブリッジ
Door	ドア
DoorLock	ドアロック
Fan	ファン
GarageDoorOpener	ガレージドアオープナー
IPCamera	IPカメラ
Lightbulb	電球
Outlet	コンセント
ProgrammableSwitch	プログラマブルスイッチ
RangeExtender	中継器
Sensor	センサー
Switch	スイッチ
Thermostat	サーモスタット
VideoDoorbell	ビデオドアベル
Window	窓
WindowCovering	ブラインド
AirPurifier	空気清浄機
AirHeater	ヒーター
AirConditioner	エアコン
AirHumidifier	加湿器
AirDehumidifier	除湿機

HMService.serviceType一覧

表. serviceType一覧

HMServiceType〜	説明
AccessoryInformation	アクセサリ情報サービス
AirPurifier	空気清浄機
AirQualitySensor	清浄度センサー
Battery	バッテリー
CarbonDioxideSensor	二酸化炭素センサー
CarbonMonoxideSensor	一酸化炭素センサー
ContactSensor	接触センサー
Door	ドア
Doorbell	ドアベル
Fan	ファン
VentilationFan	ファン
FilterMaintenance	フィルタ点検
GarageDoorOpener	ガレージドアオープナー
HeaterCooler	冷暖房機
HumidifierDehumidifier	加湿機・除湿機
HumiditySensor	湿度センサー
LeakSensor	漏れセンサー
LightSensor	光センサー
Lightbulb	電球
LockManagement	施錠管理
LockMechanism	施錠機構
Microphone	マイク
MotionSensor	モーションセンサー
OccupancySensor	人感センサー
Outlet	コンセント
SecuritySystem	セキュリティシステム
Label	ラベル
Slats	スラット（羽板）
SmokeSensor	煙センサー
Speaker	スピーカー
StatelessProgrammableSwitch	ステートレス・プログラマブル・スイッチ
StatefulProgrammableSwitch	ステートフル・プログラマブル・スイッチ
Switch	スイッチ
TemperatureSensor	温度センサー
Thermostat	サーモスタット
Window	窓
WindowCovering	ブラインド
CameraControl	カメラコントロール
CameraRTPStreamManagement	RTPストリームマネジメント

HMCharacteristic.characteristicType一覧

表. characteristicType一覧

HMCharacteristicType〜	説明	フォーマット	単位	対応するenum（HMCharacteristicValue〜）
Active	動作中	uint8		ActivationState
AdminOnlyAccess	管理者のみアクセス可能	bool
AirParticulateDensity	空気中の微粒子の濃度	float	micrograms/m^3
AirParticulateSize	空気中の微粒子のサイズ	uint8		AirParticulateSize
AirQuality	空気質	uint8		AirQuality
AudioFeedback	オーディオフィードバック	bool
BatteryLevel	電池残量	uint8	percentage
Brightness	明るさ	int	percentage
CarbonDioxideDetected	二酸化炭素を検知	uint8		CarbonDioxideDetectionStatus
CarbonDioxideLevel	二酸化炭素レベル	float	ppm
CarbonDioxidePeakLevel	二酸化炭素ピークレベル	float	ppm
CarbonMonoxideDetected	一酸化炭素を検知	uint8		CarbonMonoxideDetectionStatus
CarbonMonoxideLevel	一酸化炭素レベル	float	ppm
CarbonMonoxidePeakLevel	一酸化炭素ピークレベル	float	ppm
ChargingState	充電の状態	uint8		ChargingState
ColorTemperature	色温度	int
ContactState	接触センサーの状態	uint8		ContactState
CoolingThreshold	冷房のしきい値温度	float	celsius
CurrentAirPurifierState	現在の空気清浄機の状態	uint8		CurrentAirPurifierState
CurrentDoorState	現在のドアの状態	uint8		DoorState
CurrentFanState	現在のファンの状態	uint8		CurrentFanState
CurrentHeaterCoolerState	現在の冷暖房機の状態	uint8		CurrentHeaterCoolerState
CurrentHeatingCooling	現在の冷暖房の状態	uint8		HeatingCooling
CurrentHorizontalTilt	現在の横方向の傾斜角度	int	arcdegrees
CurrentHumidifierDehumidifierState	現在の加湿機・除湿機の状態	uint8		CurrentHumidifierDehumidifierState
CurrentLightLevel	現在の光量	float	lux
CurrentLockMechanismState	施錠機構の現在の状態	uint8		LockMechanismState
CurrentPosition	現在の位置	uint8	percentage	PositionState
CurrentRelativeHumidity	現在の相対湿度	float	percentage
CurrentSecuritySystemState	現在のセキュリティシステムの状態	uint8		CurrentSecuritySystemState
CurrentSlatState	現在のスラット（羽板）の状態	uint8		CurrentSlatState
CurrentTemperature	現在の温度	float	celsius
CurrentTilt	現在の傾斜角度	int	arcdegrees
CurrentVerticalTilt	現在の縦方向の傾斜角度	int	arcdegrees
DehumidifierThreshold	除湿機のしきい値	float	percentage
FilterChangeIndication	フィルタ交換表示	uint8		FilterChange
FilterLifeLevel	フィルタ寿命レベル	float
FilterResetChangeIndication	フィルタ交換表示をリセット	uint8
HeatingThreshold	暖房のしきい値温度	float	celsius
HoldPosition	固定位置	bool
Hue	色相	float	arcdegrees
HumidifierThreshold	加湿機のしきい値	float	percentage
InputEvent	プログラマブル・スイッチ・イベント	uint8		InputEvent
LabelIndex	ラベルの索引	uint8
LabelNamespace	ラベルの名前空間	uint8		LabelNamespace
LeakDetected	漏れを検知	uint8		LeakStatus
LockManagementAutoSecureTimeout	施錠管理の自動セキュリティタイムアウト	uint32	seconds
LockManagementControlPoint	施錠管理のコントロールポイント	tlv8
LockMechanismLastKnownAction	施錠機構の最後の既知の動作	uint8		LockMechanismLastKnownAction
LockPhysicalControls	コントロールボタンをロック	uint8		LockPhysicalControlsState
Logs	ログ	tlv8
MotionDetected	動きを検知	bool
Name	名前	string
NitrogenDioxideDensity	二酸化窒素濃度	float	micrograms/m^3
ObstructionDetected	障害物を検知	bool
OccupancyDetected	人を検知	uint8		OccupancyStatus
OutletInUse	コンセント使用中	bool
OzoneDensity	オゾン濃度	float	micrograms/m^3
PM2_5Density	PM2.5濃度	float	micrograms/m^3
PM10Density	PM10濃度	float	micrograms/m^3
PositionState	位置の状態	uint8		PositionState
PowerState	電源の状態	bool
RotationDirection	回転方向	int		RotationDirection
RotationSpeed	回転速度	float	percentage
Saturation	彩度	float	percentage
SecuritySystemAlarmType	セキュリティシステムのアラームのタイプ	uint8		SecuritySystemAlarmType
SlatType	スラット（羽板）のタイプ	uint8		SlatType
SmokeDetected	煙を検知	uint8		SmokeDetectionStatus
StatusActive	状況（作動中）	bool
StatusFault	状況（故障中）	uint8		StatusFault
StatusJammed	状況（異常により停止中）	uint8		JammedStatus
StatusLowBattery	状況（電池残量低下）	uint8		BatteryStatus
StatusTampered	状況（不正な変更）	uint8		TamperedStatus
SulphurDioxideDensity	二酸化硫黄濃度	float	micrograms/m^3
SwingMode	スイングのモード	uint8		SwingMode
TargetAirPurifierState	空気清浄機の目標状態	uint8		TargetAirPurifierState
TargetDoorState	ドアの目標状態	uint8		DoorState
TargetFanState	ファンの目標状態	uint8		TargetFanState
TargetHeaterCoolerState	冷暖房機の目標状態	uint8		TargetHeaterCoolerState
TargetHeatingCooling	冷暖房の目標状態	uint8		HeatingCooling
TargetHorizontalTilt	横方向の傾斜角度の目標値	int	arcdegrees
TargetHumidifierDehumidifierState	加湿機・除湿機の目標状態	uint8		TargetHumidifierDehumidifierState
TargetLockMechanismState	施錠機構の目標状態	uint8		LockMechanismState
TargetPosition	目標位置	uint8	percentage
TargetRelativeHumidity	相対湿度の目標値	float	percentage
TargetSecuritySystemState	セキュリティシステムの目標状態	uint8		TargetSecuritySystemState
TargetTemperature	目標温度	float	celsius
TargetTilt	傾斜の目標角度	int	arcdegrees
TargetVerticalTilt	縦方向の傾斜角度の目標値	int	arcdegrees
TemperatureUnits	温度表示装置	uint8		TemperatureUnit
Version	バージョン	string
VolatileOrganicCompoundDensity	揮発性有機化合物濃度	float	micrograms/m^3
WaterLevel	水位	float	percentage
OutputState	（情報がないため不明）
StreamingStatus	ストリーミングの状況	tlv8
SetupStreamEndpoint	IPカメラ設定	tlv8
SupportedVideoStreamConfiguration	サポートされているビデオストリーム構成	tlv8
SupportedAudioStreamConfiguration	サポートされているオーディオストリーム構成	tlv8
SupportedRTPConfiguration	サポートされているRTP構成	tlv8
SelectedStreamConfiguration	選択されたRTP構成	tlv8
Volume	音量	int	percentage
Mute	消音	bool
NightVision	ナイトビジョン	bool
OpticalZoom	光学ズーム	float
DigitalZoom	デジタルズーム	float
ImageRotation	画像回転	float
ImageMirroring	画像反転	bool
Identify	識別	bool
HardwareVersion	ハードウェアのバージョン	string
SoftwareVersion	ソフトウェアのバージョン	string

（フォーマットがtlv8となっているものは「HomeKit Accessory Protocol Specification」に値の詳細が記載されている場合があります）

HMCharacteristicMetadata.format一覧

表. format一覧

HMCharacteristicMetadataFormat〜	値
Bool	bool
Int	int
Float	float
String	string
Array	array
Dictionary	dict
UInt8	uint8
UInt16	uint16
UInt32	uint32
UInt64	uint64
Data	data
TLV8	tlv8

HMCharacteristicMetadata.units一覧

表. units一覧

HMCharacteristicMetadataUnits〜	値
Celsius	celsius
Fahrenheit	fahrenheit
Percentage	percentage
ArcDegree	arcdegrees
Seconds	seconds
Lux	lux
PartsPerMillion	ppm
MicrogramsPerCubicMeter	micrograms/m^3