Skip to content

エンティティ ​

この統合は、公式アプリケーションからリバースエンジニアリングされたほぼすべての設定と状態を公開します。各デバイスごとにエンティティが動的に生成されます。デバイスが特定のハードウェア機能やプロパティを欠いている場合、対応するエンティティはHome Assistantに追加されません。

エンティティエンティティ

メインの掃除機エンティティを含むほとんどのエンティティは、現在の状態を反映する動的アイコンが提供されます。これらのアイコンは、希望する場合、エンティティの設定で上書きすることができます。さらに、ほとんどのセンサーエンティティおよびすべてのセレクトエンティティは、raw_value、map_id、またはsegment_id属性の下で生の整数値を返すため、オートメーションやサービスでの使用が簡単になります。

すべてのエンティティには動的な更新頻度が適用され、その頻度は予想される変化の頻度と現在のデバイス状態によって決まります。Home Assistantは、リスナーを通じてプロパティの更新が検出されたときのみ変更を通知され、ローカルプッシュ方式と同様に機能します。

状態同期遅延

公式アプリで直接行った変更が、エンティティに反映されるまでに時間がかかる場合があります。この遅延は、Local や Xiaomi Home の接続方法を使用する場合に予想されます。これらの方法は、他の接続方法が使用する即時のクラウドプッシュ通知ではなく、定期的なデータポーリングに依存しているためです。

特定のエンティティには、公式アプリから抽出されたロジックを反映するために、他のエンティティの状態に関連したカスタム可用性ルールがあります。例えば、tight_mopping スイッチは、水タンクまたはモップパッドが取り付けられていない場合に使用不可になります。クラウド接続されたエンティティは、デバイス自体ではなく特定のマップデータ内に保存された設定、例えば map_rotation にも対応しています。

エンティティの可用性およびファームウェアの制限

古いファームウェアバージョンのデバイスでは、customized_cleaning や cleaning_mode などの一部のエンティティが利用できない場合があります。さらに、一部のエンティティはデフォルトで無効になっており、他のエンティティは掃除機エンティティの属性を通じて直接アクセス可能です。

生成されるすべてのエンティティは標準的な命名スキーマに従います:

[domain].[vacuum name]_[entity name] (例: switch.l10s_gen2_resume_cleaning)

スイッチ ​

名前説明注意事項
resume_cleaning再開清掃機能を有効/無効にするバキュームエンティティは、充電中に清掃が続行される前に状態をpausedとして返します
carpet_boostカーペットブースト機能を有効/無効にする
carpet_recognition認識機能を有効/無効にする超音波センサー付きのバキュームで利用可能
obstacle_avoidance3D障害物回避を有効/無効にするレーザーライン搭載掃除機で利用可能
customized_cleaningカスタマイズされた部屋清掃を有効/無効にするファームウェアが1056以上のデバイスで利用可能
child_lockチャイルドロックを有効/無効にする
tight_moppingタイトモッピングパターンを有効/無効にするファームウェアが1056以上のデバイスで利用可能、水タンクまたはモップパッドが装着されていない場合は利用不可
dndおやすみモードを有効/無効にする
multi_floor_map複数階マップを有効/無効にする複数マップを保存できるバキュームで利用可能
auto_dust_collecting清掃完了後の自動ゴミ収集を有効/無効にする自動排出ステーション付きのバキュームで利用可能
self_clean自動セルフクリーニング機能を有効/無効にする自動洗浄ベース搭載掃除機で利用可能
self_clean_by_zone特定のゾーンを掃除した後にモップパッドを自動で清掃するゾーンごとのセルフクリーニング機能があるデバイスで利用可能
auto_drying掃除が完了した後にモップを自動で乾燥させる機能を有効/無効にする自動洗浄ベース搭載掃除機で利用可能
water_electrolysis水電解機能を有効/無効にする水電解機能がある掃除機で利用可能
auto_water_refillingセルフウォッシュベースへの外部水入力を有効/無効にするセルフウォッシュベースと外部水入力がある掃除機で利用可能
auto_mount_mop選択した掃除モードに従ってモップパッドの自動組み立て・分解を有効/無効にする自動モップ組み立て機能がある掃除機で利用可能
carpet_avoidanceモップパッドを装着している場合はカーペットを避けるモップパッドリフト機能がある掃除機で利用可能
auto_add_detergentモップパッドを清掃するために洗剤カートリッジを使用するセルフウォッシュベースと洗剤カートリッジがある掃除機で利用可能
auto_charging自動で充電基地に戻る自動充電機能があるデバイスで利用可能
map_savingVSLAMデバイスの地図保存モード設定LiDARナビゲーションのない掃除機で利用可能
ai_obstacle_detectionAI障害物検知を有効/無効にするS10およびL10sモデルで利用可能
ai_obstacle_image_upload障害物の写真をクラウドにアップロードする機能を有効/無効にする前面カメラ付きデバイスで利用可能
ai_obstacle_picture障害物写真の表示を有効/無効にする前面カメラ付きデバイスで利用可能
ai_pet_detectionAIペット検知を有効/無効にする前面カメラ付きデバイスで利用可能
ai_human_detectionAI人間検知を有効/無効にするS10およびS10 Proで利用可能
ai_furniture_detectionAI家具検知を有効/無効にする前面カメラ付きデバイスで利用可能
ai_fluid_detectionAI液体検知を有効/無効にする前面カメラ付きデバイスで利用可能
fill_lightオンにすると、暗い環境で自動的にライトを点灯して障害物回避能力と動画の画面の鮮明さを向上させる前面カメラと前方ライト付きデバイスで利用可能
collision_avoidanceオンにすると、壁、家具、障害物との衝突が減少し、掃除効率とカバレッジはわずかに低下するこの機能付きデバイスで利用可能
stain_avoidanceオンにすると、汚れを検出した際にそのエリアを避け、掃除を行わないAI流体検知機能を搭載したデバイスで利用可能
intelligent_recognitionマルチフロアマップが有効な場合に自動マップ切り替えを有効/無効WiFiマップ機能を搭載したデバイスで利用可能
cleaning_sequenceカスタムルーム清掃順序を有効/無効マップ機能で利用可能(これは動的に作成されたエンティティであり、実際に直接設定には紐付いていません。オフにすると現在の清掃順序が削除され、デフォルトの順序で再生成されます。再度オンにすると前回の順序がメモリから復元されます)
voice_assistant掃除機の内蔵音声アシスタントを有効/無効音声アシスタント機能を搭載したデバイスで利用可能
fuzzy_obstacle_detection掃除機が不明瞭または識別困難な障害物を検知して回避できるようにするAI不明瞭障害物検知機能を搭載したデバイスで利用可能
ai_pet_avoidanceAIカメラを使用して掃除中にペットを識別し、積極的に回避ペットディテクティブ機能を搭載したデバイスで利用可能
pet_picture清掃中に遭遇したペットの写真を自動で撮影ペットディテクティブ機能を搭載したデバイスで利用可能
pet_focused_detectionペットやペット関連の物体の検出を優先するペット用家具機能を搭載したデバイスで利用可能
floor_direction_cleaning傷を防ぐために床板の方向に沿って掃除するフロア方向の掃除機能を搭載したデバイスで利用可能
pet_focused_cleaningペットを検出した場合は掃除方法を調整するペットディテクティブ機能を搭載したデバイスで利用可能
smart_charging清掃作業を完了し再開するのに必要な正確なバッテリー量を計算する自動充電機能があるデバイスで利用可能
human_followカメラを使って人に追従させることを許可するモップパッドスイングとカメラストリーミング機能を搭載したデバイスで利用可能
max_suction_power集中的な掃除のために最大吸引力モードを有効にする最大吸引力機能を搭載したデバイスで利用可能
smart_drying環境湿度に応じて乾燥時間を自動調整するスマート乾燥機能を搭載したデバイスで利用可能
hot_washingベースステーションでモップパッドを温水で洗浄する温水洗浄機能はあるが、スマートモップ洗浄機能はないデバイスで利用可能
uv_sterilizationモップまたは水タンクに対してUVライト消毒を有効にするUV消毒機能を搭載したデバイスで利用可能
camera_light_brightness_auto内蔵カメラの補助光の明るさを自動調整しますカメラストリーミングと補助光機能を備えたデバイスで利用可能
off_peak_charging掃除機の充電を電力ピーク時間外のみにスケジュール電力ピーク時間外充電機能を備えたデバイスで利用可能
mopping_under_furnituresモップパッドを伸ばして低い家具の下を徹底的に掃除モップパッドスイングプラス機能を備えたデバイスで利用可能
gap_cleaning_extensionモップパッドを狭い隙間や端部に伸ばすモップパッドスイングプラス機能を備えたデバイスで利用可能
intensive_carpet_cleaning吸引力を増加させ、カーペット専用の清掃パターンを調整集中的なカーペット清掃機能を備えたデバイスで利用可能
large_particles_boost大きなゴミを検出したときに一時的に吸引力を強化大きな粒子ブースト機能を備えたデバイスで利用可能
ultra_clean_modeエリア全体を非常に集中的に掃除するウルトラクリーンモードを備え、スマートモップ洗浄機能のないデバイスで利用可能
streaming_voice_promptカメラストリームがアクティブなときに音声ガイドを有効化カメラストリーミング機能を備えたデバイスで利用可能
clean_carpets_firstカーペットのあるエリアを優先して掃除し、その後に硬い床に移動するカーペット優先清掃機能を備えた機器で利用可能
silent_dryingモップパッドの乾燥中に騒音を減らす静音乾燥機能を備えた機器で利用可能
hair_compressionゴミ箱内の収集された髪を自動で圧縮してスペースを節約する髪圧縮機能を備えた機器で利用可能
side_brush_carpet_rotateカーペットに移動する際にサイドブラシの回転動作を調整するサイドブラシカーペット回転機能を備えた機器で利用可能
side_reachエッジ掃除を向上させるためにサイドブラシを伸ばすサイドリーチ機能を備えた機器で利用可能
smart_mop_washingモップの汚れ具合に応じてモップ洗浄時間を動的に調整するスマートモップ洗浄機能を備えた機器で利用可能
dnd_disable_resume_cleaningおやすみモード時間中に一時停止した掃除を再開させないDND機能を備えた機器で利用可能
dnd_disable_auto_emptyおやすみモード時間中にベースステーションがゴミ箱を自動で空にしないようにするDND機能を備えた機器で利用可能
dnd_reduce_volumeドゥ・ノット・ディスターブ時間中に掃除機の音声プロンプトの音量を下げるDND機能を備えた機器で利用可能
auto_change_mop清掃の要件に応じて自動的に異なるモップパッドを取り外し・取り付け自動モップ交換機能を持つデバイスで利用可能
lift_chassis_on_carpet高毛足のカーペットをより良く移動するために掃除機の本体を持ち上げるカーペットでの本体持ち上げ機能を持つデバイスで利用可能
close_roller_cover_on_carpetカーペットに引っかからないようにメインローラーブラシカバーを閉じるローラーカバー機能を持つデバイスで利用可能
dust_bag_dryingベースステーション内のダストバッグを温風で乾かす手動ダストバッグ乾燥機能を持つデバイスで利用可能
ring_light_always_on掃除機のインジケーターリングライトを常に点灯させておくリングライト常時点灯機能を持つデバイスで利用可能
active_suspension_crossing高い敷居や障害物の上を掃除機が通れるようにアクティブサスペンションを使用アクティブサスペンション機能を持つデバイスで利用可能
dynamic_obstacle_cleaning新たに検出された障害物に応じて清掃経路を動的に調整動的障害物清掃機能付きデバイスで利用可能
pressurized_cleaningしみ取りを良くするためにモップパッドに下方向の圧力をかける加圧清掃機能付きデバイスで利用可能
lds_stateLDS(レーザー距離センサー)モジュールのリフト状態を切り替える自動LDSリフト機能付きデバイスで利用可能
mop_washing_with_detergentモップパッドを洗うときに洗剤を自動で混ぜる自動洗剤投入および洗剤を使ったモップ機能付きデバイスで利用可能
mop_extendモップパッドを伸ばして端のカバー範囲を広げるモップ伸長機能付きデバイスで利用可能
mopping_with_detergentモップ掛けのために水タンクへ洗剤を自動で追加洗剤を使ったモップ機能付きデバイスで利用可能
obstacle_crossing難しい障害物を登るために車輪とサスペンションを調整障害物越え機能付きデバイスで利用可能

センサー ​

名前説明注意事項
cleaning_time最後の/現在の清掃作業の清掃時間高速マッピング中は利用不可
mapping_time現在の高速マッピング作業のマッピング時間ロボットが高速マッピング中のみ利用可能
cleaned_area前回/現在の清掃作業の清掃エリア高速マッピング中は利用不可
stateロボットの状態Home Assistant には標準で存在しないロボット状態をこのエンティティが公開します。例えば charging_completed
statusロボットのステータス
relocation_statusロボットの再配置状況
task_statusロボットのタスク状況
water_tankロボットの水タンク状況水タンク搭載の掃除機で利用可能
mop_padロボットの水拭きパッドの状態自動洗浄ベース搭載掃除機で利用可能
dust_collectionゴミ収集の可用性ステータス自動排出ステーション付きのバキュームで利用可能
auto_empty_status自動排出ドックの状態自動排出ステーション付きのバキュームで利用可能
self_wash_base_status自動洗浄ベースの状態自動洗浄ベース搭載掃除機で利用可能
errorロボットの故障コード説明エラー報告
charging_statusロボットの充電状況
battery_levelロボットのバッテリー残量
first_cleaning_date初清掃日
total_cleaning_time総清掃時間
cleaning_count総清掃回数
total_cleaned_area総清掃面積
stream_statusライブカメラのビデオストリームの現在の状況(例:待機中、ストリーミング中)カメラストリーミング機能を備えたデバイスで利用可能
drainage_statusベースステーションの排水システムの現在の状況水チェック機能搭載デバイスで利用可能
low_water_warningベースステーションの清水タンク残量が少なくなっているかを示します自動洗浄ベース付きデバイスで利用可能
task_type現在実行中のタスクの種類(例:掃除、戻る、洗浄)タスクタイプ機能を搭載したデバイスで利用可能
firmware_version掃除機に現在インストールされているファームウェアのバージョン
cleaning_progress現在の清掃作業の完了率清掃進捗機能を搭載したデバイスで利用可能
drying_progress現在のモップ乾燥サイクルの完了率自動洗浄ベース付きデバイスで利用可能
dust_bag_drying_statusダストバッグ乾燥プロセスの現在の状態(例:乾燥中、待機中)手動または自動ダストバッグ乾燥機能付きデバイスで利用可能
clean_water_tank_statusベースステーションの清水タンクの現在の状態とレベル自動洗浄ベース付きデバイスで利用可能
dirty_water_tank_statusベースステーションの汚水タンクの現在の状態とレベル自動洗浄ベース付きデバイスで利用可能
dust_bag_statusダストコレクションバッグの現在の状態(例:設置済み、満杯、欠品)自動排出ステーションを搭載したデバイスで利用可能
detergent_statusベースステーションの洗剤カートリッジの現在の状態自動洗浄ベース付きデバイスで利用可能
hot_water_statusモップ洗浄用の温水ヒーターの現在の温度または状態温水洗浄機能を搭載したデバイスで利用可能
station_drainage_status自動水接続排水システムの現在の状態排水機能付きデバイスで利用可能

消耗品用センサーエンティティ ​

消耗品センサーエンティティは動的に生成され、さまざまなデバイス部品やアクセサリの残り寿命や残り時間を報告します。

消耗品エンティティの詳細については ​

マップ用センサーエンティティ マップサポート ​

マップセンサーエンティティは、保存されたマップから動的に生成され、マップに関連する状態を報告します。

マップエンティティの詳細については ​

バイナリセンサー ​

名前説明注意事項
charging_state掃除機が現在ベースステーションで充電中かどうかを示します
roller_cover_statusメインローラーブラシのカバーが正しく装着または閉じられているかを示しますローラーカバー機能を持つデバイスで利用可能
lds_statusLDS(レーザー距離センサー)モジュールが持ち上げ位置にあるかを示します自動LDSリフト機能付きデバイスで利用可能

数字 ​

名前説明注意事項
volume音量レベル
mop_cleaning_remainderモップ洗浄リマインダー
camera_light_brightnessカメラの補助光の目標明るさレベルカメラストリーミングと補助光機能を備えたデバイスで利用可能
self_clean_areaモップを洗浄する前に掃除する指定エリアのサイズ(平方メートル)モップ清掃頻度機能がないセルフウォッシュベース付きデバイスで利用可能
self_clean_time戻る前にモップを掃除する指定時間(分)自動清掃頻度はあるが、モップ清掃頻度機能がないデバイスで利用可能
wetness_levelモップパッドの拭き掃除時の目標湿度レベル湿度レベル機能を搭載したデバイスで利用可能
drying_timeモップパッドを乾燥させる指定時間(時間)自動洗浄ベースおよびモップ清掃頻度または長時間乾燥機能があるデバイスで利用可能
auto_empty_areaゴミ箱を空にする前に掃除する指定エリアサイズ自動ゴミ捨てエリアおよびモード機能があるデバイスで利用可能

時間 ​

名前説明注意事項
dnd_startおやすみモード開始おやすみモード無効時は利用不可
dnd_endおやすみモード終了おやすみモード無効時は利用不可
off_peak_charging_start電力オフピーク時充電の開始時間電力ピーク時間外充電機能を備えたデバイスで利用可能
off_peak_charging_end電力オフピーク時充電の終了時間電力ピーク時間外充電機能を備えたデバイスで利用可能

ボタン ​

名前説明注意事項
start_auto_empty自動ゴミ捨て開始自動排出ステーション付きのバキュームで利用可能
clear_warning警告の解除クリア警告がない場合は利用不可
self_cleanモップ洗浄を手動で開始/一時停止自動洗浄ベース搭載掃除機で利用可能、洗浄不可時は利用不可
manual_dryingモップ乾燥を手動で開始/停止セルフウォッシュベース付きの掃除機で利用可能で、乾燥が不可能な場合は利用できません
manual_dust_bag_dryingダストバッグの乾燥プロセスを手動で開始または停止します手動または自動ダストバッグ乾燥機能付きデバイスで利用可能
water_tank_drainingベースステーションの内部水路を排水するように作動させます排水機能付きデバイスで利用可能
base_station_self_repairベースステーションの自己診断および修理ルーチンを作動させます自動洗浄ベース付きデバイスで利用可能
start_recleaning掃除機に前回の清掃作業を最初から再開するように指示します自動再清掃およびマップ機能付きデバイスで利用可能です
empty_water_tank掃除機に搭載された水タンクを完全に空にするように指示します水タンク排水機能付きデバイスで利用可能です
base_station_cleaningベースステーションの洗い場用セルフクリーニングルーチンを作動させますステーション清掃機能付きデバイスで利用可能です
reload_shortcuts掃除機から保存された清掃ショートカットを再読み込みしますショートカット機能付きデバイスで利用可能です
shortcut_{1-33}特定の保存された清掃ショートカットを実行しますショートカット機能付きデバイスで利用可能です

消耗品用ボタンエンティティ ​

消耗品ボタンエンティティは、部品やアクセサリーの交換または清掃後に残り寿命をリセットするために使用されます。

消耗品エンティティの詳細については ​

マップ用ボタンエンティティ マップサポート ​

マップボタンエンティティは、マッピング機能をトリガーしたり、保存されたマップと対話するために使用されます。

マップエンティティの詳細については ​

選択 ​

名前説明注意事項
suction_level掃除機の吸引レベルカスタマイズ清掃が有効で、現在の作業がゾーン清掃またはスポット清掃でない場合は使用できません
water_volume掃除機の水量水タンク付き掃除機で利用可能。カスタマイズ清掃が有効で、現在の作業がゾーン清掃またはスポット清掃でない場合は使用できません
mop_pad_humidityモップパッドの湿度レベル自動洗浄ベース付き掃除機で利用可能。カスタマイズ清掃が有効で、現在の作業がゾーン清掃またはスポット清掃でない場合は使用できません
cleaning_mode掃除機の清掃モード(掃き掃除、モップ掛け、掃き掃除とモップ掛け)清掃中は使用できません。
(持ち上げ可能なモップパッドを持たない掃除機の場合、オプションは動的に生成されます)
carpet_sensitivityカーペットブースト機能のカーペット感度カーペットブーストが無効の場合は使用できません
auto_empty_frequency自動排出の頻度自動集塵が無効または利用できない場合は使用できません
self_clean_areaモップパッドを掃除する前に清掃エリアを選択してください自動洗浄ベース搭載掃除機で利用可能
mop_wash_levelモップ掃除の水使用量レベルセルフウォッシュベースと外部水入力がある掃除機で利用可能
drying_timeモップ乾燥時間(分)自動洗浄ベース搭載掃除機で利用可能
mopping_type深掃除用または日常掃除用のモップタイプAI液体および汚れ検知機能を搭載した掃除機で利用可能
wider_corner_coverageモップパッドで角を掃除する際の戻り動作の頻度モップパッドのスイングおよびモップ掃除頻度機能がないデバイスで利用可能
mop_pad_swingモップパッドで端を掃除するために掃除機の後部をスイングさせる頻度モップパッドのスイングはあるが、モップ延長機能がないデバイスで利用可能
voice_assistant_language掃除機の内蔵音声アシスタントが使用する言語音声アシスタント機能を搭載したデバイスで利用可能
auto_empty_mode掃除機が自動でゴミ箱を空にするタイミングを決定するロジック自動空きモード機能を搭載したデバイスで利用可能
cleangenius部屋の清掃およびモップ設定の自動インテリジェンスを有効にするCleanGenius機能を搭載したデバイスで利用可能
auto_rewashingモップパッドの汚れ具合に基づき、再洗浄が必要かどうかを判断するロジック自動再洗浄機能が搭載された機器で利用可能
auto_recleaning強く汚れた場所が再度清掃が必要かどうかを判断するロジック自動再清掃機能が搭載された機器で利用可能
cleaning_route清掃中に使用されるナビゲーションパターン(例:標準、深掃除、速掃除)清掃ルート機能が搭載された機器で利用可能
custom_mopping_routeモッピングが有効な場合に使用される特定のナビゲーションパターンカスタムモッピングルート機能が搭載された機器で利用可能
self_clean_frequencyモップ洗浄のために戻るトリガーとなる条件(エリア、時間、または部屋)自動洗浄頻度機能が搭載された機器で利用可能
mop_clean_frequency選択された自動洗浄頻度モードに基づく特定の頻度値自動洗浄ベースおよびモップ清掃頻度機能が搭載された機器で利用可能
mop_extend_frequency選択されたモップ拡張モードに基づく特定の頻度値モップ伸長機能付きデバイスで利用可能
cleangenius_modeCleanGenius自動清掃モードの強度レベルCleanGeniusモード機能が搭載されたデバイスで利用可能
washing_modeベースステーションでのモップ洗浄サイクルの強度スマートモップ洗浄機能を備えた機器で利用可能
water_temperatureモップパッドの洗浄に使用する水の目標温度水温機能が搭載されたデバイスで利用可能
mop_pressureモップパッドにかける下方向の圧力の量モップ圧力機能を持つデバイスで利用可能
mop_temperature清掃中のモップパッドの目標温度モップ温度機能を持つデバイスで利用可能
low_lying_area_frequency低い家具の下専用の清掃頻度低いエリアの頻度機能が搭載されたデバイスで利用可能
scraper_frequencyスクレーパー工具の使用頻度(該当する場合)スクレーパーの頻度機能が搭載されたデバイスで利用可能
battery_charge_level清掃作業を再開する前に充電する目標バッテリー残量のパーセンテージ
auto_lds_coverage狭い場所でLDSセンサーを持ち上げる範囲設定自動LDSリフト機能付きデバイスで利用可能

ルーム用のエンティティを選択 マップサポート ​

ルーム選択エンティティは保存されたマップから動的に生成され、部屋ごとのカスタマイズされた掃除設定を編集するために使用されます。

カスタマイズされた清掃機能の詳細について ​

マップ用エンティティを選択 マップサポート ​

マップ用の選択エンティティは、保存されたマップとやり取りするために使用されます。

マップエンティティの詳細については ​

カメラ マップサポート ​

カメラエンティティはクラウド接続を使用する場合にのみ利用可能で、ライブマップおよび保存されたマップを表示するために使用されます。

カメラエンティティに関する詳細情報 ​