Narzędzia i bieżąca dostępność
Referencja opisuje narzędzia Home MCP oraz wymagania każdego z nich. Klient pokazuje tylko narzędzia zgodne z używanym kontem, instalacją i jej możliwościami.
Połącz klienta, aby zobaczyć listę dostępną w bieżącej sesji. Home MCP sprawdza konto, dostęp do instalacji i wymagane możliwości również przy każdym wywołaniu.
Jak czytać referencję
Każde narzędzie zawiera opis celu, dostawcę, wymaganą możliwość, schemat wejścia, schemat wyjścia i adnotacje bezpieczeństwa. Adnotacje wskazują, czy narzędzie tylko odczytuje dane, może wykonać działanie destrukcyjne, jest idempotentne albo komunikuje się z systemem zewnętrznym.
Narzędzia Home MCP
- Endpoint
/mcp- Operacje
- 49
home-assistant
Capture Home Assistant eventscapture_home_assistant_events
Capture a short, filtered, redacted Home Assistant event sample and always unsubscribe before returning
- Dostawca
- homeAssistant
- Uprawnienie
- user
- Wymagane możliwości
- home.read
Adnotacje bezpieczeństwa
- Tylko do odczytu: Tak
- Destrukcyjne: Nie
- Idempotentne: Tak
- Otwarty świat: Nie
Schemat wejścia
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"durationMs": {
"default": 3000,
"type": "integer",
"minimum": 250,
"maximum": 10000
},
"entityIds": {
"maxItems": 20,
"type": "array",
"items": {
"type": "string",
"minLength": 3,
"maxLength": 255,
"pattern": "^[a-z0-9_]+\\.[a-z0-9_]+$"
}
},
"eventTypes": {
"minItems": 1,
"maxItems": 5,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 100
}
},
"installationKey": {
"description": "Optional Hombee home identifier. Omit it when only one home is connected.",
"type": "string",
"minLength": 1
},
"maxEvents": {
"default": 50,
"type": "integer",
"minimum": 1,
"maximum": 200
}
},
"required": [
"durationMs",
"eventTypes",
"maxEvents"
],
"additionalProperties": false
}Schemat wyjścia
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"capability": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"available",
"permission_denied",
"unsupported"
]
}
},
"required": [
"status"
],
"additionalProperties": false
},
"data": {
"anyOf": [
{
"type": "object",
"properties": {
"events": {
"type": "array",
"items": {
"$ref": "#/$defs/__schema0"
}
},
"reason": {
"type": "string",
"enum": [
"cancelled",
"limit",
"timeout"
]
},
"truncated": {
"type": "boolean"
}
},
"required": [
"events",
"reason",
"truncated"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"installationKey": {
"type": "string",
"minLength": 1
}
},
"required": [
"capability",
"data",
"installationKey"
],
"additionalProperties": false,
"$defs": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/$defs/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/$defs/__schema0"
}
}
]
}
}
}Create Home Assistant automationcreate_home_assistant_automation
Create a new Home Assistant automation after Home Assistant validates its triggers, conditions, and actions
- Dostawca
- homeAssistant
- Uprawnienie
- user
- Wymagane możliwości
- home.control
Adnotacje bezpieczeństwa
- Tylko do odczytu: Nie
- Destrukcyjne: Nie
- Idempotentne: Nie
- Otwarty świat: Nie
Schemat wejścia
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"config": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/$defs/__schema0"
},
"description": "Complete Home Assistant automation configuration object. It may contain direct triggers, conditions, and actions or any installed automation use_blueprint configuration."
},
"helperRequirements": {
"description": "Generic idempotent helper requirements to provision before saving the automation. This is independent of blueprint path.",
"maxItems": 32,
"type": "array",
"items": {
"type": "object",
"properties": {
"entityId": {
"type": "string",
"pattern": "^(input_boolean|input_number|timer)\\.[a-z0-9_]{1,128}$",
"description": "Stable entity ID for a Home Assistant storage helper required by the automation"
},
"settings": {
"description": "Optional helper settings. input_boolean supports icon; input_number supports icon, initial, min, max, mode, step, and unit_of_measurement; timer supports duration, icon, and restore. The friendly name is derived from entityId when creating the helper.",
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/$defs/__schema0"
}
}
},
"required": [
"entityId"
],
"additionalProperties": false
}
},
"installationKey": {
"description": "Optional Hombee home identifier. Omit it when only one home is connected.",
"type": "string",
"minLength": 1
}
},
"required": [
"config"
],
"additionalProperties": false,
"$defs": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/$defs/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/$defs/__schema0"
}
}
]
}
}
}Schemat wyjścia
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"activation": {
"type": "string",
"enum": [
"pending",
"verified"
]
},
"automation": {
"type": "object",
"properties": {
"alias": {
"type": "string"
},
"automationId": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"pattern": "^[A-Za-z0-9_-]+$",
"description": "Path-safe Home Assistant automation configuration ID"
},
"enabled": {
"type": "boolean"
},
"entityId": {
"type": "string",
"minLength": 1
},
"lastTriggered": {
"type": "string"
},
"config": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/$defs/__schema0"
},
"description": "Complete Home Assistant automation configuration object. It may contain direct triggers, conditions, and actions or any installed automation use_blueprint configuration."
},
"revision": {
"type": "string",
"pattern": "^[a-f0-9]{64}$",
"description": "SHA-256 hash (hex-encoded)"
}
},
"required": [
"alias",
"automationId",
"enabled",
"entityId",
"config",
"revision"
],
"additionalProperties": false
},
"automationId": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"pattern": "^[A-Za-z0-9_-]+$",
"description": "Path-safe Home Assistant automation configuration ID"
},
"helperProvisioning": {
"type": "array",
"items": {
"type": "object",
"properties": {
"entityId": {
"type": "string",
"minLength": 1
},
"status": {
"type": "string",
"enum": [
"created",
"unchanged",
"updated"
]
}
},
"required": [
"entityId",
"status"
],
"additionalProperties": false
}
},
"installationKey": {
"type": "string",
"minLength": 1
},
"persistence": {
"type": "string",
"const": "persisted"
}
},
"required": [
"activation",
"automationId",
"helperProvisioning",
"installationKey",
"persistence"
],
"additionalProperties": false,
"$defs": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/$defs/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/$defs/__schema0"
}
}
]
}
}
}Delete Home Assistant automationdelete_home_assistant_automation
Delete an editable Home Assistant automation when its current revision and confirmation ID match
- Dostawca
- homeAssistant
- Uprawnienie
- user
- Wymagane możliwości
- home.control
Adnotacje bezpieczeństwa
- Tylko do odczytu: Nie
- Destrukcyjne: Tak
- Idempotentne: Tak
- Otwarty świat: Nie
Schemat wejścia
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"automationId": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"pattern": "^[A-Za-z0-9_-]+$",
"description": "Path-safe Home Assistant automation configuration ID"
},
"confirmAutomationId": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"pattern": "^[A-Za-z0-9_-]+$",
"description": "Repeat the exact automation ID to confirm deletion"
},
"expectedRevision": {
"type": "string",
"pattern": "^[a-f0-9]{64}$",
"description": "Revision returned by get_home_assistant_automation"
},
"installationKey": {
"description": "Optional Hombee home identifier. Omit it when only one home is connected.",
"type": "string",
"minLength": 1
}
},
"required": [
"automationId",
"confirmAutomationId",
"expectedRevision"
],
"additionalProperties": false
}Schemat wyjścia
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"automationId": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"pattern": "^[A-Za-z0-9_-]+$",
"description": "Path-safe Home Assistant automation configuration ID"
},
"deletion": {
"type": "string",
"enum": [
"pending",
"verified"
]
},
"installationKey": {
"type": "string",
"minLength": 1
},
"persistence": {
"type": "string",
"const": "deleted"
}
},
"required": [
"automationId",
"deletion",
"installationKey",
"persistence"
],
"additionalProperties": false
}Delete Home Assistant device registry entrydelete_home_assistant_device_registry_entry
Delete one Home Assistant device registry entry after matching all attached entity platforms and the repeated confirmation ID
- Dostawca
- homeAssistant
- Uprawnienie
- user
- Wymagane możliwości
- home.control
Adnotacje bezpieczeństwa
- Tylko do odczytu: Nie
- Destrukcyjne: Tak
- Idempotentne: Tak
- Otwarty świat: Nie
Schemat wejścia
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"confirmDeviceId": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"description": "Repeat the exact device ID to confirm deletion"
},
"deviceId": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"expectedConfigEntryId": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"description": "Only config entry ID currently owning the device, returned by the registry lists"
},
"expectedPlatform": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"pattern": "^[a-z0-9_]+$"
},
"installationKey": {
"description": "Optional Hombee home identifier. Omit it when only one home is connected.",
"type": "string",
"minLength": 1
}
},
"required": [
"confirmDeviceId",
"deviceId",
"expectedConfigEntryId",
"expectedPlatform"
],
"additionalProperties": false
}Schemat wyjścia
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"capability": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"available",
"permission_denied",
"unsupported"
]
}
},
"required": [
"status"
],
"additionalProperties": false
},
"data": {
"anyOf": [
{
"type": "object",
"properties": {
"deletedDeviceId": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"deletion": {
"type": "string",
"const": "verified"
}
},
"required": [
"deletedDeviceId",
"deletion"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"installationKey": {
"type": "string",
"minLength": 1
}
},
"required": [
"capability",
"data",
"installationKey"
],
"additionalProperties": false
}Delete Home Assistant entity registry entrydelete_home_assistant_entity_registry_entry
Delete one Home Assistant entity registry entry after matching its platform and repeated confirmation ID
- Dostawca
- homeAssistant
- Uprawnienie
- user
- Wymagane możliwości
- home.control
Adnotacje bezpieczeństwa
- Tylko do odczytu: Nie
- Destrukcyjne: Tak
- Idempotentne: Tak
- Otwarty świat: Nie
Schemat wejścia
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"confirmEntityId": {
"type": "string",
"minLength": 3,
"maxLength": 255,
"pattern": "^[a-z0-9_]+\\.[a-z0-9_]+$",
"description": "Repeat the exact entity ID to confirm deletion"
},
"entityId": {
"type": "string",
"minLength": 3,
"maxLength": 255,
"pattern": "^[a-z0-9_]+\\.[a-z0-9_]+$"
},
"expectedPlatform": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"pattern": "^[a-z0-9_]+$"
},
"installationKey": {
"description": "Optional Hombee home identifier. Omit it when only one home is connected.",
"type": "string",
"minLength": 1
}
},
"required": [
"confirmEntityId",
"entityId",
"expectedPlatform"
],
"additionalProperties": false
}Schemat wyjścia
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"capability": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"available",
"permission_denied",
"unsupported"
]
}
},
"required": [
"status"
],
"additionalProperties": false
},
"data": {
"anyOf": [
{
"type": "object",
"properties": {
"deletedEntityId": {
"type": "string",
"minLength": 3,
"maxLength": 255,
"pattern": "^[a-z0-9_]+\\.[a-z0-9_]+$"
},
"deletion": {
"type": "string",
"const": "verified"
}
},
"required": [
"deletedEntityId",
"deletion"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"installationKey": {
"type": "string",
"minLength": 1
}
},
"required": [
"capability",
"data",
"installationKey"
],
"additionalProperties": false
}Diagnose Home Assistant automationdiagnose_home_assistant_automation
Diagnose one Home Assistant automation by joining its config validation, state, referenced entity availability, and recent traces
- Dostawca
- homeAssistant
- Uprawnienie
- user
- Wymagane możliwości
- home.read
Adnotacje bezpieczeństwa
- Tylko do odczytu: Tak
- Destrukcyjne: Nie
- Idempotentne: Tak
- Otwarty świat: Nie
Schemat wejścia
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"automationId": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"pattern": "^[A-Za-z0-9_-]+$"
},
"installationKey": {
"description": "Optional Hombee home identifier. Omit it when only one home is connected.",
"type": "string",
"minLength": 1
}
},
"required": [
"automationId"
],
"additionalProperties": false
}Schemat wyjścia
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"capability": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"available",
"permission_denied",
"unsupported"
]
}
},
"required": [
"status"
],
"additionalProperties": false
},
"data": {
"anyOf": [
{
"type": "object",
"properties": {
"automation": {
"$ref": "#/$defs/__schema0"
},
"recentTraces": {
"type": "array",
"items": {
"$ref": "#/$defs/__schema0"
}
},
"referencedEntities": {
"type": "array",
"items": {
"type": "object",
"properties": {
"entityId": {
"type": "string"
},
"state": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"status": {
"type": "string",
"enum": [
"available",
"missing",
"unavailable"
]
}
},
"required": [
"entityId",
"state",
"status"
],
"additionalProperties": false
}
},
"traceError": {
"type": "string"
},
"validation": {
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "string"
}
},
"sections": {
"type": "object",
"properties": {
"actions": {
"type": "object",
"properties": {
"error": {
"type": "string"
},
"valid": {
"type": "boolean"
}
},
"required": [
"valid"
],
"additionalProperties": false
},
"conditions": {
"type": "object",
"properties": {
"error": {
"type": "string"
},
"valid": {
"type": "boolean"
}
},
"required": [
"valid"
],
"additionalProperties": false
},
"triggers": {
"type": "object",
"properties": {
"error": {
"type": "string"
},
"valid": {
"type": "boolean"
}
},
"required": [
"valid"
],
"additionalProperties": false
}
},
"required": [
"actions",
"conditions",
"triggers"
],
"additionalProperties": false
},
"valid": {
"type": "boolean"
}
},
"required": [
"errors",
"sections",
"valid"
],
"additionalProperties": false
}
},
"required": [
"automation",
"recentTraces",
"referencedEntities",
"validation"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"installationKey": {
"type": "string",
"minLength": 1
}
},
"required": [
"capability",
"data",
"installationKey"
],
"additionalProperties": false,
"$defs": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/$defs/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/$defs/__schema0"
}
}
]
}
}
}Get Alarmo configurationget_alarmo_configuration
Read the authenticated homeowner's Alarmo areas, sensor groups, sensor settings, and revision without exposing users, PINs, or MQTT credentials
- Dostawca
- homeAssistant
- Uprawnienie
- user
- Wymagane możliwości
- home.read
Adnotacje bezpieczeństwa
- Tylko do odczytu: Tak
- Destrukcyjne: Nie
- Idempotentne: Tak
- Otwarty świat: Nie
Schemat wejścia
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"installationKey": {
"description": "Optional Hombee home identifier. Omit it when only one home is connected.",
"type": "string",
"minLength": 1
}
},
"additionalProperties": false
}Schemat wyjścia
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"configuration": {
"type": "object",
"properties": {
"areas": {
"type": "array",
"items": {
"type": "object",
"properties": {
"areaId": {
"type": "string",
"minLength": 1
},
"modes": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/$defs/__schema0"
}
},
"name": {
"type": "string"
}
},
"required": [
"areaId",
"modes",
"name"
],
"additionalProperties": false
}
},
"general": {
"type": "object",
"properties": {
"codeArmRequired": {
"type": "boolean"
},
"codeDisarmRequired": {
"type": "boolean"
},
"codeFormat": {
"type": "string"
},
"codeModeChangeRequired": {
"type": "boolean"
},
"disarmAfterTrigger": {
"type": "boolean"
},
"ignoreBlockingSensorsAfterTrigger": {
"type": "boolean"
}
},
"required": [
"codeArmRequired",
"codeDisarmRequired",
"codeFormat",
"codeModeChangeRequired",
"disarmAfterTrigger",
"ignoreBlockingSensorsAfterTrigger"
],
"additionalProperties": false
},
"revision": {
"type": "string",
"pattern": "^[a-f0-9]{64}$",
"description": "SHA-256 hash (hex-encoded)"
},
"sensorGroups": {
"type": "array",
"items": {
"type": "object",
"properties": {
"entities": {
"type": "array",
"items": {
"type": "string"
}
},
"eventCount": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"groupId": {
"type": "string",
"minLength": 1
},
"name": {
"type": "string"
},
"timeoutSeconds": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"entities",
"eventCount",
"groupId",
"name",
"timeoutSeconds"
],
"additionalProperties": false
}
},
"sensors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"allowOpen": {
"type": "boolean"
},
"alwaysOn": {
"type": "boolean"
},
"areaId": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"armOnClose": {
"type": "boolean"
},
"autoBypass": {
"type": "boolean"
},
"autoBypassModes": {
"type": "array",
"items": {
"type": "string",
"enum": [
"armed_away",
"armed_home",
"armed_night",
"armed_custom_bypass",
"armed_vacation"
]
}
},
"delayOnSeconds": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"enabled": {
"type": "boolean"
},
"entityId": {
"type": "string",
"pattern": "^binary_sensor\\.[a-z0-9_]+$",
"description": "Home Assistant binary sensor entity ID"
},
"entryDelaySeconds": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"groupId": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"modes": {
"minItems": 1,
"type": "array",
"items": {
"type": "string",
"enum": [
"armed_away",
"armed_home",
"armed_night",
"armed_custom_bypass",
"armed_vacation"
]
}
},
"sensorType": {
"type": "string",
"enum": [
"door",
"window",
"motion",
"tamper",
"environmental",
"other"
]
},
"triggerUnavailable": {
"type": "boolean"
},
"useEntryDelay": {
"type": "boolean"
},
"useExitDelay": {
"type": "boolean"
}
},
"required": [
"allowOpen",
"alwaysOn",
"areaId",
"armOnClose",
"autoBypass",
"autoBypassModes",
"delayOnSeconds",
"enabled",
"entityId",
"entryDelaySeconds",
"groupId",
"modes",
"sensorType",
"triggerUnavailable",
"useEntryDelay",
"useExitDelay"
],
"additionalProperties": false
}
}
},
"required": [
"areas",
"general",
"revision",
"sensorGroups",
"sensors"
],
"additionalProperties": false
},
"installationKey": {
"type": "string",
"minLength": 1
}
},
"required": [
"configuration",
"installationKey"
],
"additionalProperties": false,
"$defs": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/$defs/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/$defs/__schema0"
}
}
]
}
}
}Get Home Assistant automationget_home_assistant_automation
Read one complete editable Home Assistant automation and its revision for safe updates
- Dostawca
- homeAssistant
- Uprawnienie
- user
- Wymagane możliwości
- home.read
Adnotacje bezpieczeństwa
- Tylko do odczytu: Tak
- Destrukcyjne: Nie
- Idempotentne: Tak
- Otwarty świat: Nie
Schemat wejścia
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"automationId": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"pattern": "^[A-Za-z0-9_-]+$",
"description": "Path-safe Home Assistant automation configuration ID"
},
"installationKey": {
"description": "Optional Hombee home identifier. Omit it when only one home is connected.",
"type": "string",
"minLength": 1
}
},
"required": [
"automationId"
],
"additionalProperties": false
}Schemat wyjścia
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"automation": {
"type": "object",
"properties": {
"alias": {
"type": "string"
},
"automationId": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"pattern": "^[A-Za-z0-9_-]+$",
"description": "Path-safe Home Assistant automation configuration ID"
},
"enabled": {
"type": "boolean"
},
"entityId": {
"type": "string",
"minLength": 1
},
"lastTriggered": {
"type": "string"
},
"config": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/$defs/__schema0"
},
"description": "Complete Home Assistant automation configuration object. It may contain direct triggers, conditions, and actions or any installed automation use_blueprint configuration."
},
"revision": {
"type": "string",
"pattern": "^[a-f0-9]{64}$",
"description": "SHA-256 hash (hex-encoded)"
}
},
"required": [
"alias",
"automationId",
"enabled",
"entityId",
"config",
"revision"
],
"additionalProperties": false
},
"installationKey": {
"type": "string",
"minLength": 1
}
},
"required": [
"automation",
"installationKey"
],
"additionalProperties": false,
"$defs": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/$defs/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/$defs/__schema0"
}
}
]
}
}
}Get Home Assistant automation traceget_home_assistant_automation_trace
Read one complete Home Assistant automation trace by automation and run identifier
- Dostawca
- homeAssistant
- Uprawnienie
- user
- Wymagane możliwości
- home.read
Adnotacje bezpieczeństwa
- Tylko do odczytu: Tak
- Destrukcyjne: Nie
- Idempotentne: Tak
- Otwarty świat: Nie
Schemat wejścia
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"automationId": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"pattern": "^[A-Za-z0-9_-]+$"
},
"installationKey": {
"description": "Optional Hombee home identifier. Omit it when only one home is connected.",
"type": "string",
"minLength": 1
},
"runId": {
"type": "string",
"minLength": 1,
"maxLength": 128
}
},
"required": [
"automationId",
"runId"
],
"additionalProperties": false
}Schemat wyjścia
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"capability": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"available",
"permission_denied",
"unsupported"
]
}
},
"required": [
"status"
],
"additionalProperties": false
},
"data": {
"anyOf": [
{
"type": "object",
"properties": {
"trace": {
"$ref": "#/$defs/__schema0"
}
},
"required": [
"trace"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"installationKey": {
"type": "string",
"minLength": 1
}
},
"required": [
"capability",
"data",
"installationKey"
],
"additionalProperties": false,
"$defs": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/$defs/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/$defs/__schema0"
}
}
]
}
}
}Get Home Assistant blueprintget_home_assistant_blueprint
Read the installed metadata and native input selectors for one Home Assistant blueprint
- Dostawca
- homeAssistant
- Uprawnienie
- user
- Wymagane możliwości
- home.read
Adnotacje bezpieczeństwa
- Tylko do odczytu: Tak
- Destrukcyjne: Nie
- Idempotentne: Tak
- Otwarty świat: Nie
Schemat wejścia
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"domain": {
"default": "automation",
"description": "Home Assistant blueprint domain",
"type": "string",
"enum": [
"automation",
"script"
]
},
"installationKey": {
"description": "Optional Hombee home identifier. Omit it when only one home is connected.",
"type": "string",
"minLength": 1
},
"path": {
"type": "string",
"minLength": 1,
"maxLength": 512,
"description": "Relative blueprint path returned by list_home_assistant_blueprints, for example hombee/occupancy-aware.yaml"
}
},
"required": [
"path"
],
"additionalProperties": false
}Schemat wyjścia
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"blueprint": {
"oneOf": [
{
"type": "object",
"properties": {
"metadata": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/$defs/__schema0"
}
},
"path": {
"type": "string",
"minLength": 1
},
"status": {
"type": "string",
"const": "loaded"
}
},
"required": [
"metadata",
"path",
"status"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"error": {
"type": "string"
},
"path": {
"type": "string",
"minLength": 1
},
"status": {
"type": "string",
"const": "error"
}
},
"required": [
"error",
"path",
"status"
],
"additionalProperties": false
}
]
},
"domain": {
"default": "automation",
"description": "Home Assistant blueprint domain",
"type": "string",
"enum": [
"automation",
"script"
]
},
"installationKey": {
"type": "string",
"minLength": 1
}
},
"required": [
"blueprint",
"domain",
"installationKey"
],
"additionalProperties": false,
"$defs": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/$defs/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/$defs/__schema0"
}
}
]
}
}
}Get Home Assistant entity diagnosticsget_home_assistant_entity_diagnostics
Read current state, attributes, registry, device, and integration evidence for one Home Assistant entity
- Dostawca
- homeAssistant
- Uprawnienie
- user
- Wymagane możliwości
- home.read
Adnotacje bezpieczeństwa
- Tylko do odczytu: Tak
- Destrukcyjne: Nie
- Idempotentne: Tak
- Otwarty świat: Nie
Schemat wejścia
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"entityId": {
"type": "string",
"minLength": 3,
"maxLength": 255,
"pattern": "^[a-z0-9_]+\\.[a-z0-9_]+$"
},
"installationKey": {
"description": "Optional Hombee home identifier. Omit it when only one home is connected.",
"type": "string",
"minLength": 1
}
},
"required": [
"entityId"
],
"additionalProperties": false
}Schemat wyjścia
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"capability": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"available",
"permission_denied",
"unsupported"
]
}
},
"required": [
"status"
],
"additionalProperties": false
},
"data": {
"anyOf": [
{
"type": "object",
"properties": {
"device": {
"anyOf": [
{
"$ref": "#/$defs/__schema0"
},
{
"type": "null"
}
]
},
"integration": {
"anyOf": [
{
"$ref": "#/$defs/__schema0"
},
{
"type": "null"
}
]
},
"registry": {
"anyOf": [
{
"$ref": "#/$defs/__schema0"
},
{
"type": "null"
}
]
},
"state": {
"$ref": "#/$defs/__schema0"
},
"summary": {
"type": "object",
"properties": {
"areaId": {
"type": "string"
},
"available": {
"type": "boolean"
},
"deviceId": {
"type": "string"
},
"disabledBy": {
"type": "string"
},
"entityId": {
"type": "string",
"minLength": 3,
"maxLength": 255,
"pattern": "^[a-z0-9_]+\\.[a-z0-9_]+$"
},
"friendlyName": {
"type": "string"
},
"lastChanged": {
"type": "string"
},
"lastUpdated": {
"type": "string"
},
"platform": {
"type": "string"
},
"state": {
"type": "string"
}
},
"required": [
"available",
"entityId",
"state"
],
"additionalProperties": false
}
},
"required": [
"device",
"integration",
"registry",
"state",
"summary"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"installationKey": {
"type": "string",
"minLength": 1
}
},
"required": [
"capability",
"data",
"installationKey"
],
"additionalProperties": false,
"$defs": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/$defs/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/$defs/__schema0"
}
}
]
}
}
}Get Home Assistant entity historyget_home_assistant_entity_history
Read bounded Home Assistant entity state history for a maximum seven-day UTC range
- Dostawca
- homeAssistant
- Uprawnienie
- user
- Wymagane możliwości
- home.read
Adnotacje bezpieczeństwa
- Tylko do odczytu: Tak
- Destrukcyjne: Nie
- Idempotentne: Tak
- Otwarty świat: Nie
Schemat wejścia
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"endTime": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"startTime": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"cursor": {
"type": "string",
"pattern": "^ha:\\d+$"
},
"entityIds": {
"minItems": 1,
"maxItems": 20,
"type": "array",
"items": {
"type": "string",
"minLength": 3,
"maxLength": 255,
"pattern": "^[a-z0-9_]+\\.[a-z0-9_]+$"
}
},
"includeAttributes": {
"default": false,
"type": "boolean"
},
"installationKey": {
"description": "Optional Hombee home identifier. Omit it when only one home is connected.",
"type": "string",
"minLength": 1
},
"maxStatesPerEntity": {
"default": 500,
"type": "integer",
"minimum": 1,
"maximum": 2000
}
},
"required": [
"startTime",
"entityIds",
"includeAttributes",
"maxStatesPerEntity"
],
"additionalProperties": false
}Schemat wyjścia
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"capability": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"available",
"permission_denied",
"unsupported"
]
}
},
"required": [
"status"
],
"additionalProperties": false
},
"data": {
"anyOf": [
{
"type": "object",
"properties": {
"endTime": {
"type": "string"
},
"series": {
"type": "array",
"items": {
"type": "object",
"properties": {
"entityId": {
"type": "string",
"minLength": 3,
"maxLength": 255,
"pattern": "^[a-z0-9_]+\\.[a-z0-9_]+$"
},
"nextCursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"states": {
"type": "array",
"items": {
"$ref": "#/$defs/__schema0"
}
},
"truncated": {
"type": "boolean"
}
},
"required": [
"entityId",
"nextCursor",
"states",
"truncated"
],
"additionalProperties": false
}
},
"startTime": {
"type": "string"
}
},
"required": [
"endTime",
"series",
"startTime"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"installationKey": {
"type": "string",
"minLength": 1
}
},
"required": [
"capability",
"data",
"installationKey"
],
"additionalProperties": false,
"$defs": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/$defs/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/$defs/__schema0"
}
}
]
}
}
}Get Home Assistant integration statusget_home_assistant_integration_status
Read Home Assistant config-entry setup states, disabled reasons, sources, and domains with secrets removed
- Dostawca
- homeAssistant
- Uprawnienie
- user
- Wymagane możliwości
- home.read
Adnotacje bezpieczeństwa
- Tylko do odczytu: Tak
- Destrukcyjne: Nie
- Idempotentne: Tak
- Otwarty świat: Nie
Schemat wejścia
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"domain": {
"type": "string",
"pattern": "^[a-z0-9_]+$"
},
"installationKey": {
"description": "Optional Hombee home identifier. Omit it when only one home is connected.",
"type": "string",
"minLength": 1
},
"limit": {
"default": 100,
"type": "integer",
"minimum": 1,
"maximum": 200
}
},
"required": [
"limit"
],
"additionalProperties": false
}Schemat wyjścia
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"capability": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"available",
"permission_denied",
"unsupported"
]
}
},
"required": [
"status"
],
"additionalProperties": false
},
"data": {
"anyOf": [
{
"type": "object",
"properties": {
"entries": {
"type": "array",
"items": {
"$ref": "#/$defs/__schema0"
}
},
"totalMatched": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"entries",
"totalMatched"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"installationKey": {
"type": "string",
"minLength": 1
}
},
"required": [
"capability",
"data",
"installationKey"
],
"additionalProperties": false,
"$defs": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/$defs/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/$defs/__schema0"
}
}
]
}
}
}Get Home Assistant logbookget_home_assistant_logbook
Read bounded Home Assistant logbook events for a maximum seven-day UTC range
- Dostawca
- homeAssistant
- Uprawnienie
- user
- Wymagane możliwości
- home.read
Adnotacje bezpieczeństwa
- Tylko do odczytu: Tak
- Destrukcyjne: Nie
- Idempotentne: Tak
- Otwarty świat: Nie
Schemat wejścia
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"endTime": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"startTime": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"contextId": {
"type": "string",
"maxLength": 128
},
"cursor": {
"type": "string",
"pattern": "^ha:\\d+$"
},
"deviceIds": {
"maxItems": 20,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 128
}
},
"entityIds": {
"maxItems": 20,
"type": "array",
"items": {
"type": "string",
"minLength": 3,
"maxLength": 255,
"pattern": "^[a-z0-9_]+\\.[a-z0-9_]+$"
}
},
"installationKey": {
"description": "Optional Hombee home identifier. Omit it when only one home is connected.",
"type": "string",
"minLength": 1
},
"limit": {
"default": 100,
"type": "integer",
"minimum": 1,
"maximum": 500
}
},
"required": [
"startTime",
"limit"
],
"additionalProperties": false
}Schemat wyjścia
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"capability": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"available",
"permission_denied",
"unsupported"
]
}
},
"required": [
"status"
],
"additionalProperties": false
},
"data": {
"anyOf": [
{
"type": "object",
"properties": {
"endTime": {
"type": "string"
},
"events": {
"type": "array",
"items": {
"$ref": "#/$defs/__schema0"
}
},
"nextCursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"startTime": {
"type": "string"
},
"truncated": {
"type": "boolean"
}
},
"required": [
"endTime",
"events",
"nextCursor",
"startTime",
"truncated"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"installationKey": {
"type": "string",
"minLength": 1
}
},
"required": [
"capability",
"data",
"installationKey"
],
"additionalProperties": false,
"$defs": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/$defs/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/$defs/__schema0"
}
}
]
}
}
}Get Home Assistant recorder statusget_home_assistant_recorder_status
Read recorder thread, backlog, migration, database-location, and recording status
- Dostawca
- homeAssistant
- Uprawnienie
- user
- Wymagane możliwości
- home.read
Adnotacje bezpieczeństwa
- Tylko do odczytu: Tak
- Destrukcyjne: Nie
- Idempotentne: Tak
- Otwarty świat: Nie
Schemat wejścia
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"installationKey": {
"description": "Optional Hombee home identifier. Omit it when only one home is connected.",
"type": "string",
"minLength": 1
}
},
"additionalProperties": false
}Schemat wyjścia
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"capability": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"available",
"permission_denied",
"unsupported"
]
}
},
"required": [
"status"
],
"additionalProperties": false
},
"data": {
"anyOf": [
{
"type": "object",
"properties": {
"status": {
"$ref": "#/$defs/__schema0"
}
},
"required": [
"status"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"installationKey": {
"type": "string",
"minLength": 1
}
},
"required": [
"capability",
"data",
"installationKey"
],
"additionalProperties": false,
"$defs": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/$defs/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/$defs/__schema0"
}
}
]
}
}
}Get Home Assistant statisticsget_home_assistant_statistics
Read bounded long-term Home Assistant statistics for selected statistic identifiers
- Dostawca
- homeAssistant
- Uprawnienie
- user
- Wymagane możliwości
- home.read
Adnotacje bezpieczeństwa
- Tylko do odczytu: Tak
- Destrukcyjne: Nie
- Idempotentne: Tak
- Otwarty świat: Nie
Schemat wejścia
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"endTime": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"startTime": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"cursor": {
"type": "string",
"pattern": "^ha:\\d+$"
},
"installationKey": {
"description": "Optional Hombee home identifier. Omit it when only one home is connected.",
"type": "string",
"minLength": 1
},
"maxPointsPerStatistic": {
"default": 500,
"type": "integer",
"minimum": 1,
"maximum": 2000
},
"period": {
"type": "string",
"enum": [
"5minute",
"hour",
"day",
"week",
"month",
"year"
]
},
"statisticIds": {
"minItems": 1,
"maxItems": 20,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"types": {
"default": [
"mean",
"min",
"max",
"state",
"sum"
],
"minItems": 1,
"type": "array",
"items": {
"type": "string",
"enum": [
"change",
"last_reset",
"max",
"mean",
"min",
"state",
"sum"
]
}
}
},
"required": [
"startTime",
"maxPointsPerStatistic",
"period",
"statisticIds",
"types"
],
"additionalProperties": false
}Schemat wyjścia
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"capability": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"available",
"permission_denied",
"unsupported"
]
}
},
"required": [
"status"
],
"additionalProperties": false
},
"data": {
"anyOf": [
{
"type": "object",
"properties": {
"endTime": {
"type": "string"
},
"series": {
"type": "array",
"items": {
"type": "object",
"properties": {
"points": {
"type": "array",
"items": {
"$ref": "#/$defs/__schema0"
}
},
"nextCursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"statisticId": {
"type": "string"
},
"truncated": {
"type": "boolean"
}
},
"required": [
"points",
"nextCursor",
"statisticId",
"truncated"
],
"additionalProperties": false
}
},
"startTime": {
"type": "string"
}
},
"required": [
"endTime",
"series",
"startTime"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"installationKey": {
"type": "string",
"minLength": 1
}
},
"required": [
"capability",
"data",
"installationKey"
],
"additionalProperties": false,
"$defs": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/$defs/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/$defs/__schema0"
}
}
]
}
}
}Get Home Assistant system healthget_home_assistant_system_health
Read a redacted Home Assistant system-health snapshot and report whether all asynchronous probes completed
- Dostawca
- homeAssistant
- Uprawnienie
- user
- Wymagane możliwości
- home.read
Adnotacje bezpieczeństwa
- Tylko do odczytu: Tak
- Destrukcyjne: Nie
- Idempotentne: Tak
- Otwarty świat: Nie
Schemat wejścia
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"installationKey": {
"description": "Optional Hombee home identifier. Omit it when only one home is connected.",
"type": "string",
"minLength": 1
}
},
"additionalProperties": false
}Schemat wyjścia
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"capability": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"available",
"permission_denied",
"unsupported"
]
}
},
"required": [
"status"
],
"additionalProperties": false
},
"data": {
"anyOf": [
{
"type": "object",
"properties": {
"complete": {
"type": "boolean"
},
"reason": {
"type": "string",
"enum": [
"completed",
"limit",
"timeout"
]
},
"roundTripLatencyMs": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"snapshot": {
"$ref": "#/$defs/__schema0"
},
"version": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
}
},
"required": [
"complete",
"reason",
"roundTripLatencyMs",
"snapshot",
"version"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"installationKey": {
"type": "string",
"minLength": 1
}
},
"required": [
"capability",
"data",
"installationKey"
],
"additionalProperties": false,
"$defs": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/$defs/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/$defs/__schema0"
}
}
]
}
}
}Get Home Assistant system logsget_home_assistant_system_logs
Read the bounded in-memory Home Assistant warning and error log with recursive secret redaction
- Dostawca
- homeAssistant
- Uprawnienie
- user
- Wymagane możliwości
- home.read
Adnotacje bezpieczeństwa
- Tylko do odczytu: Tak
- Destrukcyjne: Nie
- Idempotentne: Tak
- Otwarty świat: Nie
Schemat wejścia
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"cursor": {
"type": "string",
"pattern": "^ha:\\d+$"
},
"installationKey": {
"description": "Optional Hombee home identifier. Omit it when only one home is connected.",
"type": "string",
"minLength": 1
},
"levels": {
"maxItems": 3,
"type": "array",
"items": {
"type": "string",
"enum": [
"WARNING",
"ERROR",
"CRITICAL"
]
}
},
"limit": {
"default": 50,
"type": "integer",
"minimum": 1,
"maximum": 100
},
"logger": {
"type": "string",
"maxLength": 200
},
"query": {
"type": "string",
"maxLength": 200
}
},
"required": [
"limit"
],
"additionalProperties": false
}Schemat wyjścia
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"capability": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"available",
"permission_denied",
"unsupported"
]
}
},
"required": [
"status"
],
"additionalProperties": false
},
"data": {
"anyOf": [
{
"type": "object",
"properties": {
"nextCursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"records": {
"type": "array",
"items": {
"$ref": "#/$defs/__schema0"
}
},
"totalMatched": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"nextCursor",
"records",
"totalMatched"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"installationKey": {
"type": "string",
"minLength": 1
}
},
"required": [
"capability",
"data",
"installationKey"
],
"additionalProperties": false,
"$defs": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/$defs/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/$defs/__schema0"
}
}
]
}
}
}HassBroadcasthome_assistant_broadcast
Broadcast a message through the home
- Dostawca
- homeAssistant
- Uprawnienie
- user
- Wymagane możliwości
- home.control
Adnotacje bezpieczeństwa
- Tylko do odczytu: Nie
- Destrukcyjne: Tak
- Idempotentne: Nie
- Otwarty świat: Nie
Schemat wejścia
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"installationKey": {
"type": "string",
"description": "Optional Hombee home identifier. Omit it when only one home is connected."
},
"message": {
"type": "string"
}
},
"additionalProperties": {}
}Schemat wyjścia
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"availability": {
"type": "string",
"enum": [
"ambiguous_installation",
"available",
"not_connected",
"unsupported",
"upstream_error"
]
},
"error": {
"type": "string"
},
"installationKey": {
"type": "string"
},
"ok": {
"type": "boolean"
},
"result": {},
"sourceToolName": {
"type": "string"
},
"toolName": {
"type": "string"
}
},
"required": [
"availability",
"ok",
"sourceToolName",
"toolName"
],
"additionalProperties": false
}HassCancelAllTimershome_assistant_cancel_all_timers
Cancels all timers
- Dostawca
- homeAssistant
- Uprawnienie
- user
- Wymagane możliwości
- home.control
Adnotacje bezpieczeństwa
- Tylko do odczytu: Nie
- Destrukcyjne: Tak
- Idempotentne: Nie
- Otwarty świat: Nie
Schemat wejścia
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"area": {
"type": "string"
},
"installationKey": {
"type": "string",
"description": "Optional Hombee home identifier. Omit it when only one home is connected."
}
},
"additionalProperties": {}
}Schemat wyjścia
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"availability": {
"type": "string",
"enum": [
"ambiguous_installation",
"available",
"not_connected",
"unsupported",
"upstream_error"
]
},
"error": {
"type": "string"
},
"installationKey": {
"type": "string"
},
"ok": {
"type": "boolean"
},
"result": {},
"sourceToolName": {
"type": "string"
},
"toolName": {
"type": "string"
}
},
"required": [
"availability",
"ok",
"sourceToolName",
"toolName"
],
"additionalProperties": false
}GetDateTimehome_assistant_get_date_time
Provides the current date and time.
- Dostawca
- homeAssistant
- Uprawnienie
- user
- Wymagane możliwości
- home.read
Adnotacje bezpieczeństwa
- Tylko do odczytu: Tak
- Destrukcyjne: Nie
- Idempotentne: Tak
- Otwarty świat: Nie
Schemat wejścia
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"installationKey": {
"type": "string",
"description": "Optional Hombee home identifier. Omit it when only one home is connected."
}
},
"additionalProperties": {}
}Schemat wyjścia
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"availability": {
"type": "string",
"enum": [
"ambiguous_installation",
"available",
"not_connected",
"unsupported",
"upstream_error"
]
},
"error": {
"type": "string"
},
"installationKey": {
"type": "string"
},
"ok": {
"type": "boolean"
},
"result": {},
"sourceToolName": {
"type": "string"
},
"toolName": {
"type": "string"
}
},
"required": [
"availability",
"ok",
"sourceToolName",
"toolName"
],
"additionalProperties": false
}GetLiveContexthome_assistant_get_live_context
Provides real-time information about the CURRENT state, value, or mode of devices, sensors, entities, or areas. Use this tool for: 1. Answering questions about current conditions (e.g., 'Is the light on?'). 2. As the first step in conditional actions (e.g., 'If the weather is rainy, turn off sprinklers' requires checking the weather first). You may filter for devices by name, domain, and area, including combining those filters. Prefer filtering by domain when searching for multiple devices of the same type.
- Dostawca
- homeAssistant
- Uprawnienie
- user
- Wymagane możliwości
- home.read
Adnotacje bezpieczeństwa
- Tylko do odczytu: Tak
- Destrukcyjne: Nie
- Idempotentne: Tak
- Otwarty świat: Nie
Schemat wejścia
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"area": {
"type": "string",
"description": "Filter entities by area name or alias (case-insensitive)."
},
"domain": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{}
],
"description": "Filter entities by domain (e.g. 'light', 'sensor'). Accepts a single domain or a list."
},
"installationKey": {
"type": "string",
"description": "Optional Hombee home identifier. Omit it when only one home is connected."
},
"name": {
"type": "string",
"description": "Filter entities by name or alias (case-insensitive)."
}
},
"additionalProperties": {}
}Schemat wyjścia
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"availability": {
"type": "string",
"enum": [
"ambiguous_installation",
"available",
"not_connected",
"unsupported",
"upstream_error"
]
},
"error": {
"type": "string"
},
"installationKey": {
"type": "string"
},
"ok": {
"type": "boolean"
},
"result": {},
"sourceToolName": {
"type": "string"
},
"toolName": {
"type": "string"
}
},
"required": [
"availability",
"ok",
"sourceToolName",
"toolName"
],
"additionalProperties": false
}HassLightSethome_assistant_light_set
Sets the brightness percentage or color of a light
- Dostawca
- homeAssistant
- Uprawnienie
- user
- Wymagane możliwości
- home.control
Adnotacje bezpieczeństwa
- Tylko do odczytu: Nie
- Destrukcyjne: Tak
- Idempotentne: Nie
- Otwarty świat: Nie
Schemat wejścia
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"area": {
"type": "string"
},
"brightness": {
"type": "integer",
"minimum": 0,
"maximum": 100,
"description": "The brightness percentage of the light between 0 and 100, where 0 is off and 100 is fully lit"
},
"color": {
"type": "string"
},
"domain": {
"type": "array",
"items": {
"type": "string"
}
},
"floor": {
"type": "string"
},
"installationKey": {
"type": "string",
"description": "Optional Hombee home identifier. Omit it when only one home is connected."
},
"name": {
"type": "string"
},
"temperature": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"additionalProperties": {}
}Schemat wyjścia
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"availability": {
"type": "string",
"enum": [
"ambiguous_installation",
"available",
"not_connected",
"unsupported",
"upstream_error"
]
},
"error": {
"type": "string"
},
"installationKey": {
"type": "string"
},
"ok": {
"type": "boolean"
},
"result": {},
"sourceToolName": {
"type": "string"
},
"toolName": {
"type": "string"
}
},
"required": [
"availability",
"ok",
"sourceToolName",
"toolName"
],
"additionalProperties": false
}HassSetPositionhome_assistant_set_position
Sets the position of a device or entity
- Dostawca
- homeAssistant
- Uprawnienie
- user
- Wymagane możliwości
- home.control
Adnotacje bezpieczeństwa
- Tylko do odczytu: Nie
- Destrukcyjne: Tak
- Idempotentne: Nie
- Otwarty świat: Nie
Schemat wejścia
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"area": {
"type": "string"
},
"device_class": {
"type": "array",
"items": {
"type": "string",
"enum": [
"awning",
"blind",
"curtain",
"damper",
"door",
"garage",
"gas",
"gate",
"shade",
"shutter",
"water",
"window"
]
}
},
"domain": {
"type": "array",
"items": {
"type": "string"
}
},
"floor": {
"type": "string"
},
"installationKey": {
"type": "string",
"description": "Optional Hombee home identifier. Omit it when only one home is connected."
},
"name": {
"type": "string"
},
"position": {
"type": "integer",
"minimum": 0,
"maximum": 100
}
},
"additionalProperties": {}
}Schemat wyjścia
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"availability": {
"type": "string",
"enum": [
"ambiguous_installation",
"available",
"not_connected",
"unsupported",
"upstream_error"
]
},
"error": {
"type": "string"
},
"installationKey": {
"type": "string"
},
"ok": {
"type": "boolean"
},
"result": {},
"sourceToolName": {
"type": "string"
},
"toolName": {
"type": "string"
}
},
"required": [
"availability",
"ok",
"sourceToolName",
"toolName"
],
"additionalProperties": false
}HassStopMovinghome_assistant_stop_moving
Stops a moving device or entity
- Dostawca
- homeAssistant
- Uprawnienie
- user
- Wymagane możliwości
- home.control
Adnotacje bezpieczeństwa
- Tylko do odczytu: Nie
- Destrukcyjne: Tak
- Idempotentne: Nie
- Otwarty świat: Nie
Schemat wejścia
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"area": {
"type": "string"
},
"device_class": {
"type": "array",
"items": {
"type": "string",
"enum": [
"awning",
"blind",
"curtain",
"damper",
"door",
"garage",
"gas",
"gate",
"shade",
"shutter",
"water",
"window"
]
}
},
"domain": {
"type": "array",
"items": {
"type": "string"
}
},
"floor": {
"type": "string"
},
"installationKey": {
"type": "string",
"description": "Optional Hombee home identifier. Omit it when only one home is connected."
},
"name": {
"type": "string"
}
},
"additionalProperties": {}
}Schemat wyjścia
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"availability": {
"type": "string",
"enum": [
"ambiguous_installation",
"available",
"not_connected",
"unsupported",
"upstream_error"
]
},
"error": {
"type": "string"
},
"installationKey": {
"type": "string"
},
"ok": {
"type": "boolean"
},
"result": {},
"sourceToolName": {
"type": "string"
},
"toolName": {
"type": "string"
}
},
"required": [
"availability",
"ok",
"sourceToolName",
"toolName"
],
"additionalProperties": false
}HassTurnOffhome_assistant_turn_off
Turns off/closes a device or entity. For locks, this performs an 'unlock' action. Use for requests like 'turn off', 'deactivate', 'disable', or 'unlock'.
- Dostawca
- homeAssistant
- Uprawnienie
- user
- Wymagane możliwości
- home.control
Adnotacje bezpieczeństwa
- Tylko do odczytu: Nie
- Destrukcyjne: Tak
- Idempotentne: Nie
- Otwarty świat: Nie
Schemat wejścia
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"area": {
"type": "string"
},
"device_class": {
"type": "array",
"items": {
"type": "string",
"enum": [
"awning",
"blind",
"curtain",
"damper",
"door",
"garage",
"gas",
"gate",
"identify",
"outlet",
"projector",
"receiver",
"restart",
"shade",
"shutter",
"speaker",
"switch",
"tv",
"update",
"water",
"window"
]
}
},
"domain": {
"type": "array",
"items": {
"type": "string"
}
},
"floor": {
"type": "string"
},
"installationKey": {
"type": "string",
"description": "Optional Hombee home identifier. Omit it when only one home is connected."
},
"name": {
"type": "string"
}
},
"additionalProperties": {}
}Schemat wyjścia
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"availability": {
"type": "string",
"enum": [
"ambiguous_installation",
"available",
"not_connected",
"unsupported",
"upstream_error"
]
},
"error": {
"type": "string"
},
"installationKey": {
"type": "string"
},
"ok": {
"type": "boolean"
},
"result": {},
"sourceToolName": {
"type": "string"
},
"toolName": {
"type": "string"
}
},
"required": [
"availability",
"ok",
"sourceToolName",
"toolName"
],
"additionalProperties": false
}HassTurnOnhome_assistant_turn_on
Turns on/opens/presses a device or entity. For locks, this performs a 'lock' action. Use for requests like 'turn on', 'activate', 'enable', or 'lock'.
- Dostawca
- homeAssistant
- Uprawnienie
- user
- Wymagane możliwości
- home.control
Adnotacje bezpieczeństwa
- Tylko do odczytu: Nie
- Destrukcyjne: Tak
- Idempotentne: Nie
- Otwarty świat: Nie
Schemat wejścia
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"area": {
"type": "string"
},
"device_class": {
"type": "array",
"items": {
"type": "string",
"enum": [
"awning",
"blind",
"curtain",
"damper",
"door",
"garage",
"gas",
"gate",
"identify",
"outlet",
"projector",
"receiver",
"restart",
"shade",
"shutter",
"speaker",
"switch",
"tv",
"update",
"water",
"window"
]
}
},
"domain": {
"type": "array",
"items": {
"type": "string"
}
},
"floor": {
"type": "string"
},
"installationKey": {
"type": "string",
"description": "Optional Hombee home identifier. Omit it when only one home is connected."
},
"name": {
"type": "string"
}
},
"additionalProperties": {}
}Schemat wyjścia
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"availability": {
"type": "string",
"enum": [
"ambiguous_installation",
"available",
"not_connected",
"unsupported",
"upstream_error"
]
},
"error": {
"type": "string"
},
"installationKey": {
"type": "string"
},
"ok": {
"type": "boolean"
},
"result": {},
"sourceToolName": {
"type": "string"
},
"toolName": {
"type": "string"
}
},
"required": [
"availability",
"ok",
"sourceToolName",
"toolName"
],
"additionalProperties": false
}List Home Assistant area registrylist_home_assistant_area_registry
List bounded Home Assistant area registry entries with an optional text filter
- Dostawca
- homeAssistant
- Uprawnienie
- user
- Wymagane możliwości
- home.read
Adnotacje bezpieczeństwa
- Tylko do odczytu: Tak
- Destrukcyjne: Nie
- Idempotentne: Tak
- Otwarty świat: Nie
Schemat wejścia
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"installationKey": {
"description": "Optional Hombee home identifier. Omit it when only one home is connected.",
"type": "string",
"minLength": 1
},
"limit": {
"default": 200,
"type": "integer",
"minimum": 1,
"maximum": 500
},
"query": {
"type": "string",
"maxLength": 255
}
},
"required": [
"limit"
],
"additionalProperties": false
}Schemat wyjścia
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"capability": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"available",
"permission_denied",
"unsupported"
]
}
},
"required": [
"status"
],
"additionalProperties": false
},
"data": {
"anyOf": [
{
"type": "object",
"properties": {
"areas": {
"type": "array",
"items": {
"$ref": "#/$defs/__schema0"
}
},
"totalMatched": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"areas",
"totalMatched"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"installationKey": {
"type": "string",
"minLength": 1
}
},
"required": [
"capability",
"data",
"installationKey"
],
"additionalProperties": false,
"$defs": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/$defs/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/$defs/__schema0"
}
}
]
}
}
}List Home Assistant automation traceslist_home_assistant_automation_traces
List recent Home Assistant automation traces; Home Assistant administrator access may be required
- Dostawca
- homeAssistant
- Uprawnienie
- user
- Wymagane możliwości
- home.read
Adnotacje bezpieczeństwa
- Tylko do odczytu: Tak
- Destrukcyjne: Nie
- Idempotentne: Tak
- Otwarty świat: Nie
Schemat wejścia
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"automationId": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"pattern": "^[A-Za-z0-9_-]+$"
},
"cursor": {
"type": "string",
"pattern": "^ha:\\d+$"
},
"installationKey": {
"description": "Optional Hombee home identifier. Omit it when only one home is connected.",
"type": "string",
"minLength": 1
},
"limit": {
"default": 20,
"type": "integer",
"minimum": 1,
"maximum": 100
}
},
"required": [
"limit"
],
"additionalProperties": false
}Schemat wyjścia
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"capability": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"available",
"permission_denied",
"unsupported"
]
}
},
"required": [
"status"
],
"additionalProperties": false
},
"data": {
"anyOf": [
{
"type": "object",
"properties": {
"nextCursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"traces": {
"type": "array",
"items": {
"$ref": "#/$defs/__schema0"
}
},
"truncated": {
"type": "boolean"
}
},
"required": [
"nextCursor",
"traces",
"truncated"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"installationKey": {
"type": "string",
"minLength": 1
}
},
"required": [
"capability",
"data",
"installationKey"
],
"additionalProperties": false,
"$defs": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/$defs/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/$defs/__schema0"
}
}
]
}
}
}List Home Assistant automationslist_home_assistant_automations
List editable automations in the authenticated homeowner's connected Home Assistant installation
- Dostawca
- homeAssistant
- Uprawnienie
- user
- Wymagane możliwości
- home.read
Adnotacje bezpieczeństwa
- Tylko do odczytu: Tak
- Destrukcyjne: Nie
- Idempotentne: Tak
- Otwarty świat: Nie
Schemat wejścia
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"installationKey": {
"description": "Optional Hombee home identifier. Omit it when only one home is connected.",
"type": "string",
"minLength": 1
}
},
"additionalProperties": false
}Schemat wyjścia
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"automations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"alias": {
"type": "string"
},
"automationId": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"pattern": "^[A-Za-z0-9_-]+$",
"description": "Path-safe Home Assistant automation configuration ID"
},
"enabled": {
"type": "boolean"
},
"entityId": {
"type": "string",
"minLength": 1
},
"lastTriggered": {
"type": "string"
}
},
"required": [
"alias",
"automationId",
"enabled",
"entityId"
],
"additionalProperties": false
}
},
"installationKey": {
"type": "string",
"minLength": 1
}
},
"required": [
"automations",
"installationKey"
],
"additionalProperties": false
}List Home Assistant blueprintslist_home_assistant_blueprints
List installed blueprint paths and metadata in the authenticated homeowner's Home Assistant installation
- Dostawca
- homeAssistant
- Uprawnienie
- user
- Wymagane możliwości
- home.read
Adnotacje bezpieczeństwa
- Tylko do odczytu: Tak
- Destrukcyjne: Nie
- Idempotentne: Tak
- Otwarty świat: Nie
Schemat wejścia
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"domain": {
"default": "automation",
"description": "Home Assistant blueprint domain",
"type": "string",
"enum": [
"automation",
"script"
]
},
"installationKey": {
"description": "Optional Hombee home identifier. Omit it when only one home is connected.",
"type": "string",
"minLength": 1
}
},
"additionalProperties": false
}Schemat wyjścia
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"blueprints": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"properties": {
"metadata": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/$defs/__schema0"
}
},
"path": {
"type": "string",
"minLength": 1
},
"status": {
"type": "string",
"const": "loaded"
}
},
"required": [
"metadata",
"path",
"status"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"error": {
"type": "string"
},
"path": {
"type": "string",
"minLength": 1
},
"status": {
"type": "string",
"const": "error"
}
},
"required": [
"error",
"path",
"status"
],
"additionalProperties": false
}
]
}
},
"domain": {
"default": "automation",
"description": "Home Assistant blueprint domain",
"type": "string",
"enum": [
"automation",
"script"
]
},
"installationKey": {
"type": "string",
"minLength": 1
}
},
"required": [
"blueprints",
"domain",
"installationKey"
],
"additionalProperties": false,
"$defs": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/$defs/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/$defs/__schema0"
}
}
]
}
}
}List Home Assistant device registrylist_home_assistant_device_registry
List bounded Home Assistant device registry entries with optional area and text filters
- Dostawca
- homeAssistant
- Uprawnienie
- user
- Wymagane możliwości
- home.read
Adnotacje bezpieczeństwa
- Tylko do odczytu: Tak
- Destrukcyjne: Nie
- Idempotentne: Tak
- Otwarty świat: Nie
Schemat wejścia
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"areaId": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"installationKey": {
"description": "Optional Hombee home identifier. Omit it when only one home is connected.",
"type": "string",
"minLength": 1
},
"limit": {
"default": 200,
"type": "integer",
"minimum": 1,
"maximum": 500
},
"query": {
"type": "string",
"maxLength": 255
}
},
"required": [
"limit"
],
"additionalProperties": false
}Schemat wyjścia
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"capability": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"available",
"permission_denied",
"unsupported"
]
}
},
"required": [
"status"
],
"additionalProperties": false
},
"data": {
"anyOf": [
{
"type": "object",
"properties": {
"devices": {
"type": "array",
"items": {
"$ref": "#/$defs/__schema0"
}
},
"totalMatched": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"devices",
"totalMatched"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"installationKey": {
"type": "string",
"minLength": 1
}
},
"required": [
"capability",
"data",
"installationKey"
],
"additionalProperties": false,
"$defs": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/$defs/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/$defs/__schema0"
}
}
]
}
}
}List Home Assistant entity registrylist_home_assistant_entity_registry
List bounded Home Assistant entity registry entries with optional platform, device, and text filters
- Dostawca
- homeAssistant
- Uprawnienie
- user
- Wymagane możliwości
- home.read
Adnotacje bezpieczeństwa
- Tylko do odczytu: Tak
- Destrukcyjne: Nie
- Idempotentne: Tak
- Otwarty świat: Nie
Schemat wejścia
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"deviceId": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"installationKey": {
"description": "Optional Hombee home identifier. Omit it when only one home is connected.",
"type": "string",
"minLength": 1
},
"limit": {
"default": 200,
"type": "integer",
"minimum": 1,
"maximum": 500
},
"platform": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"pattern": "^[a-z0-9_]+$"
},
"query": {
"type": "string",
"maxLength": 255
}
},
"required": [
"limit"
],
"additionalProperties": false
}Schemat wyjścia
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"capability": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"available",
"permission_denied",
"unsupported"
]
}
},
"required": [
"status"
],
"additionalProperties": false
},
"data": {
"anyOf": [
{
"type": "object",
"properties": {
"entities": {
"type": "array",
"items": {
"$ref": "#/$defs/__schema0"
}
},
"totalMatched": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"entities",
"totalMatched"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"installationKey": {
"type": "string",
"minLength": 1
}
},
"required": [
"capability",
"data",
"installationKey"
],
"additionalProperties": false,
"$defs": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/$defs/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/$defs/__schema0"
}
}
]
}
}
}List Home Assistant repairslist_home_assistant_repairs
Read active Home Assistant repair issues without changing them
- Dostawca
- homeAssistant
- Uprawnienie
- user
- Wymagane możliwości
- home.read
Adnotacje bezpieczeństwa
- Tylko do odczytu: Tak
- Destrukcyjne: Nie
- Idempotentne: Tak
- Otwarty świat: Nie
Schemat wejścia
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"installationKey": {
"description": "Optional Hombee home identifier. Omit it when only one home is connected.",
"type": "string",
"minLength": 1
}
},
"additionalProperties": false
}Schemat wyjścia
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"capability": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"available",
"permission_denied",
"unsupported"
]
}
},
"required": [
"status"
],
"additionalProperties": false
},
"data": {
"anyOf": [
{
"type": "object",
"properties": {
"issues": {
"type": "array",
"items": {
"$ref": "#/$defs/__schema0"
}
}
},
"required": [
"issues"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"installationKey": {
"type": "string",
"minLength": 1
}
},
"required": [
"capability",
"data",
"installationKey"
],
"additionalProperties": false,
"$defs": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/$defs/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/$defs/__schema0"
}
}
]
}
}
}Remove Alarmo sensorremove_alarmo_sensor
Remove one Alarmo sensor when the current configuration revision and confirmation entity ID match, then verify its absence
- Dostawca
- homeAssistant
- Uprawnienie
- user
- Wymagane możliwości
- home.control
Adnotacje bezpieczeństwa
- Tylko do odczytu: Nie
- Destrukcyjne: Tak
- Idempotentne: Tak
- Otwarty świat: Nie
Schemat wejścia
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"confirmEntityId": {
"type": "string",
"pattern": "^binary_sensor\\.[a-z0-9_]+$",
"description": "Repeat the exact entity ID to confirm removal"
},
"entityId": {
"type": "string",
"pattern": "^binary_sensor\\.[a-z0-9_]+$",
"description": "Home Assistant binary sensor entity ID"
},
"expectedRevision": {
"type": "string",
"pattern": "^[a-f0-9]{64}$",
"description": "Revision returned by get_alarmo_configuration"
},
"installationKey": {
"description": "Optional Hombee home identifier. Omit it when only one home is connected.",
"type": "string",
"minLength": 1
}
},
"required": [
"confirmEntityId",
"entityId",
"expectedRevision"
],
"additionalProperties": false
}Schemat wyjścia
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"configurationRevision": {
"type": "string",
"pattern": "^[a-f0-9]{64}$",
"description": "SHA-256 hash (hex-encoded)"
},
"entityId": {
"type": "string",
"pattern": "^binary_sensor\\.[a-z0-9_]+$",
"description": "Home Assistant binary sensor entity ID"
},
"installationKey": {
"type": "string",
"minLength": 1
},
"persistence": {
"type": "string",
"const": "deleted"
},
"verification": {
"type": "string",
"const": "verified"
}
},
"required": [
"configurationRevision",
"entityId",
"installationKey",
"persistence",
"verification"
],
"additionalProperties": false
}Render Home Assistant blueprintrender_home_assistant_blueprint
Resolve one installed Home Assistant blueprint with selected inputs without saving an automation
- Dostawca
- homeAssistant
- Uprawnienie
- user
- Wymagane możliwości
- home.read
Adnotacje bezpieczeństwa
- Tylko do odczytu: Tak
- Destrukcyjne: Nie
- Idempotentne: Tak
- Otwarty świat: Nie
Schemat wejścia
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"domain": {
"default": "automation",
"description": "Home Assistant blueprint domain",
"type": "string",
"enum": [
"automation",
"script"
]
},
"input": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/$defs/__schema0"
}
},
"installationKey": {
"description": "Optional Hombee home identifier. Omit it when only one home is connected.",
"type": "string",
"minLength": 1
},
"path": {
"type": "string",
"minLength": 1,
"maxLength": 512,
"description": "Relative blueprint path returned by list_home_assistant_blueprints, for example hombee/occupancy-aware.yaml"
}
},
"required": [
"input",
"path"
],
"additionalProperties": false,
"$defs": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/$defs/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/$defs/__schema0"
}
}
]
}
}
}Schemat wyjścia
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"domain": {
"default": "automation",
"description": "Home Assistant blueprint domain",
"type": "string",
"enum": [
"automation",
"script"
]
},
"installationKey": {
"type": "string",
"minLength": 1
},
"path": {
"type": "string",
"minLength": 1,
"maxLength": 512,
"description": "Relative blueprint path returned by list_home_assistant_blueprints, for example hombee/occupancy-aware.yaml"
},
"substitutedConfig": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/$defs/__schema0"
}
}
},
"required": [
"domain",
"installationKey",
"path",
"substitutedConfig"
],
"additionalProperties": false,
"$defs": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/$defs/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/$defs/__schema0"
}
}
]
}
}
}Run Home Assistant automationrun_home_assistant_automation
Run one Home Assistant automation with conditions preserved after the confirmation ID exactly matches
- Dostawca
- homeAssistant
- Uprawnienie
- user
- Wymagane możliwości
- home.control
Adnotacje bezpieczeństwa
- Tylko do odczytu: Nie
- Destrukcyjne: Tak
- Idempotentne: Nie
- Otwarty świat: Nie
Schemat wejścia
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"automationId": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"pattern": "^[A-Za-z0-9_-]+$"
},
"confirmAutomationId": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"pattern": "^[A-Za-z0-9_-]+$",
"description": "Repeat the exact automation ID to confirm execution"
},
"installationKey": {
"description": "Optional Hombee home identifier. Omit it when only one home is connected.",
"type": "string",
"minLength": 1
}
},
"required": [
"automationId",
"confirmAutomationId"
],
"additionalProperties": false
}Schemat wyjścia
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"capability": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"available",
"permission_denied",
"unsupported"
]
}
},
"required": [
"status"
],
"additionalProperties": false
},
"data": {
"anyOf": [
{
"type": "object",
"properties": {
"automationId": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"pattern": "^[A-Za-z0-9_-]+$"
},
"entityId": {
"type": "string"
},
"skipConditions": {
"type": "boolean",
"const": false
},
"trace": {
"anyOf": [
{
"$ref": "#/$defs/__schema0"
},
{
"type": "null"
}
]
},
"triggered": {
"type": "boolean",
"const": true
}
},
"required": [
"automationId",
"entityId",
"skipConditions",
"trace",
"triggered"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"installationKey": {
"type": "string",
"minLength": 1
}
},
"required": [
"capability",
"data",
"installationKey"
],
"additionalProperties": false,
"$defs": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/$defs/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/$defs/__schema0"
}
}
]
}
}
}Search Home Assistant entitiessearch_home_assistant_entities
Search Home Assistant entities by identifier or friendly name and include availability plus safe registry relationships
- Dostawca
- homeAssistant
- Uprawnienie
- user
- Wymagane możliwości
- home.read
Adnotacje bezpieczeństwa
- Tylko do odczytu: Tak
- Destrukcyjne: Nie
- Idempotentne: Tak
- Otwarty świat: Nie
Schemat wejścia
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"domains": {
"maxItems": 20,
"type": "array",
"items": {
"type": "string",
"pattern": "^[a-z0-9_]+$"
}
},
"includeUnavailable": {
"default": true,
"type": "boolean"
},
"installationKey": {
"description": "Optional Hombee home identifier. Omit it when only one home is connected.",
"type": "string",
"minLength": 1
},
"limit": {
"default": 50,
"type": "integer",
"minimum": 1,
"maximum": 200
},
"query": {
"type": "string",
"maxLength": 200
}
},
"required": [
"includeUnavailable",
"limit"
],
"additionalProperties": false
}Schemat wyjścia
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"capability": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"available",
"permission_denied",
"unsupported"
]
}
},
"required": [
"status"
],
"additionalProperties": false
},
"data": {
"anyOf": [
{
"type": "object",
"properties": {
"entities": {
"type": "array",
"items": {
"type": "object",
"properties": {
"areaId": {
"type": "string"
},
"available": {
"type": "boolean"
},
"deviceId": {
"type": "string"
},
"disabledBy": {
"type": "string"
},
"entityId": {
"type": "string",
"minLength": 3,
"maxLength": 255,
"pattern": "^[a-z0-9_]+\\.[a-z0-9_]+$"
},
"friendlyName": {
"type": "string"
},
"lastChanged": {
"type": "string"
},
"lastUpdated": {
"type": "string"
},
"platform": {
"type": "string"
},
"state": {
"type": "string"
}
},
"required": [
"available",
"entityId",
"state"
],
"additionalProperties": false
}
},
"totalMatched": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"entities",
"totalMatched"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"installationKey": {
"type": "string",
"minLength": 1
}
},
"required": [
"capability",
"data",
"installationKey"
],
"additionalProperties": false
}Update Home Assistant automationupdate_home_assistant_automation
Replace an editable Home Assistant automation when its current revision still matches
- Dostawca
- homeAssistant
- Uprawnienie
- user
- Wymagane możliwości
- home.control
Adnotacje bezpieczeństwa
- Tylko do odczytu: Nie
- Destrukcyjne: Tak
- Idempotentne: Tak
- Otwarty świat: Nie
Schemat wejścia
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"automationId": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"pattern": "^[A-Za-z0-9_-]+$",
"description": "Path-safe Home Assistant automation configuration ID"
},
"config": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/$defs/__schema0"
},
"description": "Complete Home Assistant automation configuration object. It may contain direct triggers, conditions, and actions or any installed automation use_blueprint configuration."
},
"expectedRevision": {
"type": "string",
"pattern": "^[a-f0-9]{64}$",
"description": "Revision returned by get_home_assistant_automation"
},
"helperRequirements": {
"description": "Generic idempotent helper requirements to provision before saving the automation. This is independent of blueprint path.",
"maxItems": 32,
"type": "array",
"items": {
"type": "object",
"properties": {
"entityId": {
"type": "string",
"pattern": "^(input_boolean|input_number|timer)\\.[a-z0-9_]{1,128}$",
"description": "Stable entity ID for a Home Assistant storage helper required by the automation"
},
"settings": {
"description": "Optional helper settings. input_boolean supports icon; input_number supports icon, initial, min, max, mode, step, and unit_of_measurement; timer supports duration, icon, and restore. The friendly name is derived from entityId when creating the helper.",
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/$defs/__schema0"
}
}
},
"required": [
"entityId"
],
"additionalProperties": false
}
},
"installationKey": {
"description": "Optional Hombee home identifier. Omit it when only one home is connected.",
"type": "string",
"minLength": 1
}
},
"required": [
"automationId",
"config",
"expectedRevision"
],
"additionalProperties": false,
"$defs": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/$defs/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/$defs/__schema0"
}
}
]
}
}
}Schemat wyjścia
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"activation": {
"type": "string",
"enum": [
"pending",
"verified"
]
},
"automation": {
"type": "object",
"properties": {
"alias": {
"type": "string"
},
"automationId": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"pattern": "^[A-Za-z0-9_-]+$",
"description": "Path-safe Home Assistant automation configuration ID"
},
"enabled": {
"type": "boolean"
},
"entityId": {
"type": "string",
"minLength": 1
},
"lastTriggered": {
"type": "string"
},
"config": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/$defs/__schema0"
},
"description": "Complete Home Assistant automation configuration object. It may contain direct triggers, conditions, and actions or any installed automation use_blueprint configuration."
},
"revision": {
"type": "string",
"pattern": "^[a-f0-9]{64}$",
"description": "SHA-256 hash (hex-encoded)"
}
},
"required": [
"alias",
"automationId",
"enabled",
"entityId",
"config",
"revision"
],
"additionalProperties": false
},
"automationId": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"pattern": "^[A-Za-z0-9_-]+$",
"description": "Path-safe Home Assistant automation configuration ID"
},
"helperProvisioning": {
"type": "array",
"items": {
"type": "object",
"properties": {
"entityId": {
"type": "string",
"minLength": 1
},
"status": {
"type": "string",
"enum": [
"created",
"unchanged",
"updated"
]
}
},
"required": [
"entityId",
"status"
],
"additionalProperties": false
}
},
"installationKey": {
"type": "string",
"minLength": 1
},
"persistence": {
"type": "string",
"const": "persisted"
}
},
"required": [
"activation",
"automationId",
"helperProvisioning",
"installationKey",
"persistence"
],
"additionalProperties": false,
"$defs": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/$defs/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/$defs/__schema0"
}
}
]
}
}
}Update Home Assistant device registry entryupdate_home_assistant_device_registry_entry
Update one Home Assistant device registry entry after verifying every attached entity belongs to the expected platform
- Dostawca
- homeAssistant
- Uprawnienie
- user
- Wymagane możliwości
- home.control
Adnotacje bezpieczeństwa
- Tylko do odczytu: Nie
- Destrukcyjne: Tak
- Idempotentne: Tak
- Otwarty świat: Nie
Schemat wejścia
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"areaId": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"clearArea": {
"default": false,
"type": "boolean"
},
"clearNameByUser": {
"default": false,
"type": "boolean"
},
"deviceId": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"expectedPlatform": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"pattern": "^[a-z0-9_]+$",
"description": "Platform shared by every entity currently attached to the device"
},
"installationKey": {
"description": "Optional Hombee home identifier. Omit it when only one home is connected.",
"type": "string",
"minLength": 1
},
"nameByUser": {
"type": "string",
"minLength": 1,
"maxLength": 255
}
},
"required": [
"clearArea",
"clearNameByUser",
"deviceId",
"expectedPlatform"
],
"additionalProperties": false
}Schemat wyjścia
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"capability": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"available",
"permission_denied",
"unsupported"
]
}
},
"required": [
"status"
],
"additionalProperties": false
},
"data": {
"anyOf": [
{
"type": "object",
"properties": {
"device": {
"$ref": "#/$defs/__schema0"
}
},
"required": [
"device"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"installationKey": {
"type": "string",
"minLength": 1
}
},
"required": [
"capability",
"data",
"installationKey"
],
"additionalProperties": false,
"$defs": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/$defs/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/$defs/__schema0"
}
}
]
}
}
}Update Home Assistant entity registry entryupdate_home_assistant_entity_registry_entry
Update one Home Assistant entity registry entry after verifying its current integration platform
- Dostawca
- homeAssistant
- Uprawnienie
- user
- Wymagane możliwości
- home.control
Adnotacje bezpieczeństwa
- Tylko do odczytu: Nie
- Destrukcyjne: Tak
- Idempotentne: Tak
- Otwarty świat: Nie
Schemat wejścia
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"areaId": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"clearArea": {
"default": false,
"type": "boolean"
},
"clearName": {
"default": false,
"type": "boolean"
},
"entityId": {
"type": "string",
"minLength": 3,
"maxLength": 255,
"pattern": "^[a-z0-9_]+\\.[a-z0-9_]+$"
},
"expectedPlatform": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"pattern": "^[a-z0-9_]+$",
"description": "Current registry platform returned by list_home_assistant_entity_registry"
},
"installationKey": {
"description": "Optional Hombee home identifier. Omit it when only one home is connected.",
"type": "string",
"minLength": 1
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"newEntityId": {
"type": "string",
"minLength": 3,
"maxLength": 255,
"pattern": "^[a-z0-9_]+\\.[a-z0-9_]+$"
}
},
"required": [
"clearArea",
"clearName",
"entityId",
"expectedPlatform"
],
"additionalProperties": false
}Schemat wyjścia
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"capability": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"available",
"permission_denied",
"unsupported"
]
}
},
"required": [
"status"
],
"additionalProperties": false
},
"data": {
"anyOf": [
{
"type": "object",
"properties": {
"entity": {
"$ref": "#/$defs/__schema0"
}
},
"required": [
"entity"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"installationKey": {
"type": "string",
"minLength": 1
}
},
"required": [
"capability",
"data",
"installationKey"
],
"additionalProperties": false,
"$defs": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/$defs/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/$defs/__schema0"
}
}
]
}
}
}Upsert Alarmo sensorupsert_alarmo_sensor
Add or replace one Alarmo sensor when the current configuration revision still matches, then verify the saved configuration
- Dostawca
- homeAssistant
- Uprawnienie
- user
- Wymagane możliwości
- home.control
Adnotacje bezpieczeństwa
- Tylko do odczytu: Nie
- Destrukcyjne: Tak
- Idempotentne: Tak
- Otwarty świat: Nie
Schemat wejścia
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"allowOpen": {
"type": "boolean"
},
"alwaysOn": {
"type": "boolean"
},
"areaId": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"armOnClose": {
"type": "boolean"
},
"autoBypass": {
"type": "boolean"
},
"autoBypassModes": {
"type": "array",
"items": {
"type": "string",
"enum": [
"armed_away",
"armed_home",
"armed_night",
"armed_custom_bypass",
"armed_vacation"
]
}
},
"delayOnSeconds": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"enabled": {
"type": "boolean"
},
"entityId": {
"type": "string",
"pattern": "^binary_sensor\\.[a-z0-9_]+$",
"description": "Home Assistant binary sensor entity ID"
},
"entryDelaySeconds": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"groupId": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"modes": {
"minItems": 1,
"type": "array",
"items": {
"type": "string",
"enum": [
"armed_away",
"armed_home",
"armed_night",
"armed_custom_bypass",
"armed_vacation"
]
}
},
"sensorType": {
"type": "string",
"enum": [
"door",
"window",
"motion",
"tamper",
"environmental",
"other"
]
},
"triggerUnavailable": {
"type": "boolean"
},
"useEntryDelay": {
"type": "boolean"
},
"useExitDelay": {
"type": "boolean"
},
"expectedRevision": {
"type": "string",
"pattern": "^[a-f0-9]{64}$",
"description": "Revision returned by get_alarmo_configuration"
},
"installationKey": {
"description": "Optional Hombee home identifier. Omit it when only one home is connected.",
"type": "string",
"minLength": 1
}
},
"required": [
"allowOpen",
"alwaysOn",
"armOnClose",
"autoBypass",
"autoBypassModes",
"enabled",
"entityId",
"modes",
"sensorType",
"triggerUnavailable",
"useEntryDelay",
"useExitDelay",
"expectedRevision"
],
"additionalProperties": false
}Schemat wyjścia
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"configurationRevision": {
"type": "string",
"pattern": "^[a-f0-9]{64}$",
"description": "SHA-256 hash (hex-encoded)"
},
"installationKey": {
"type": "string",
"minLength": 1
},
"persistence": {
"type": "string",
"const": "persisted"
},
"sensor": {
"type": "object",
"properties": {
"allowOpen": {
"type": "boolean"
},
"alwaysOn": {
"type": "boolean"
},
"areaId": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"armOnClose": {
"type": "boolean"
},
"autoBypass": {
"type": "boolean"
},
"autoBypassModes": {
"type": "array",
"items": {
"type": "string",
"enum": [
"armed_away",
"armed_home",
"armed_night",
"armed_custom_bypass",
"armed_vacation"
]
}
},
"delayOnSeconds": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"enabled": {
"type": "boolean"
},
"entityId": {
"type": "string",
"pattern": "^binary_sensor\\.[a-z0-9_]+$",
"description": "Home Assistant binary sensor entity ID"
},
"entryDelaySeconds": {
"anyOf": [
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"groupId": {
"anyOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
]
},
"modes": {
"minItems": 1,
"type": "array",
"items": {
"type": "string",
"enum": [
"armed_away",
"armed_home",
"armed_night",
"armed_custom_bypass",
"armed_vacation"
]
}
},
"sensorType": {
"type": "string",
"enum": [
"door",
"window",
"motion",
"tamper",
"environmental",
"other"
]
},
"triggerUnavailable": {
"type": "boolean"
},
"useEntryDelay": {
"type": "boolean"
},
"useExitDelay": {
"type": "boolean"
}
},
"required": [
"allowOpen",
"alwaysOn",
"areaId",
"armOnClose",
"autoBypass",
"autoBypassModes",
"delayOnSeconds",
"enabled",
"entityId",
"entryDelaySeconds",
"groupId",
"modes",
"sensorType",
"triggerUnavailable",
"useEntryDelay",
"useExitDelay"
],
"additionalProperties": false
},
"verification": {
"type": "string",
"const": "verified"
}
},
"required": [
"configurationRevision",
"installationKey",
"persistence",
"sensor",
"verification"
],
"additionalProperties": false
}Validate Home Assistant automationvalidate_home_assistant_automation
Validate Home Assistant automation triggers, conditions, and actions without persisting the automation
- Dostawca
- homeAssistant
- Uprawnienie
- user
- Wymagane możliwości
- home.read
Adnotacje bezpieczeństwa
- Tylko do odczytu: Tak
- Destrukcyjne: Nie
- Idempotentne: Tak
- Otwarty świat: Nie
Schemat wejścia
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"config": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/$defs/__schema0"
},
"description": "Complete Home Assistant automation configuration object"
},
"installationKey": {
"description": "Optional Hombee home identifier. Omit it when only one home is connected.",
"type": "string",
"minLength": 1
}
},
"required": [
"config"
],
"additionalProperties": false,
"$defs": {
"__schema0": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "array",
"items": {
"$ref": "#/$defs/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/$defs/__schema0"
}
}
]
}
}
}Schemat wyjścia
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"capability": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"available",
"permission_denied",
"unsupported"
]
}
},
"required": [
"status"
],
"additionalProperties": false
},
"data": {
"anyOf": [
{
"type": "object",
"properties": {
"validation": {
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "string"
}
},
"sections": {
"type": "object",
"properties": {
"actions": {
"type": "object",
"properties": {
"error": {
"type": "string"
},
"valid": {
"type": "boolean"
}
},
"required": [
"valid"
],
"additionalProperties": false
},
"conditions": {
"type": "object",
"properties": {
"error": {
"type": "string"
},
"valid": {
"type": "boolean"
}
},
"required": [
"valid"
],
"additionalProperties": false
},
"triggers": {
"type": "object",
"properties": {
"error": {
"type": "string"
},
"valid": {
"type": "boolean"
}
},
"required": [
"valid"
],
"additionalProperties": false
}
},
"required": [
"actions",
"conditions",
"triggers"
],
"additionalProperties": false
},
"valid": {
"type": "boolean"
}
},
"required": [
"errors",
"sections",
"valid"
],
"additionalProperties": false
}
},
"required": [
"validation"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"installationKey": {
"type": "string",
"minLength": 1
}
},
"required": [
"capability",
"data",
"installationKey"
],
"additionalProperties": false
}chat
Get chat historyget_chat_history
Fetch older messages from chat history
- Dostawca
- hombee
- Uprawnienie
- user
- Wymagane możliwości
- chat.read
Adnotacje bezpieczeństwa
- Tylko do odczytu: Tak
- Destrukcyjne: Nie
- Idempotentne: Tak
- Otwarty świat: Nie
Schemat wejścia
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"before": {
"description": "Fetch messages before this timestamp (ISO format)",
"type": "string"
},
"limit": {
"description": "Maximum number of messages to return",
"default": 20,
"type": "integer",
"minimum": 1,
"maximum": 100
}
},
"additionalProperties": false
}Schemat wyjścia
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"hasMore": {
"type": "boolean"
},
"messages": {
"type": "array",
"items": {
"type": "object",
"properties": {
"content": {
"type": "string"
},
"id": {
"type": "string",
"minLength": 1
},
"role": {
"type": "string",
"enum": [
"user",
"assistant",
"tool",
"system"
]
},
"timestamp": {
"type": "number"
}
},
"required": [
"content",
"id",
"role",
"timestamp"
],
"additionalProperties": false
}
},
"totalCount": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"hasMore",
"messages",
"totalCount"
],
"additionalProperties": false
}Get report rowsget_report_rows
Fetch a range of rows from a generated report by report ID
- Dostawca
- hombee
- Uprawnienie
- user
- Wymagane możliwości
- chat.read
Adnotacje bezpieczeństwa
- Tylko do odczytu: Tak
- Destrukcyjne: Nie
- Idempotentne: Tak
- Otwarty świat: Nie
Schemat wejścia
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"limit": {
"description": "Maximum number of rows to return",
"default": 50,
"type": "integer",
"minimum": 1,
"maximum": 500
},
"reportId": {
"type": "string",
"description": "Report ID to fetch (typically the generate_report callId)"
},
"startRow": {
"description": "1-based start row index (data rows only, excluding header)",
"default": 1,
"type": "integer",
"minimum": 1,
"maximum": 1000000
}
},
"required": [
"reportId"
],
"additionalProperties": false
}Schemat wyjścia
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"oneOf": [
{
"type": "object",
"properties": {
"found": {
"type": "boolean",
"const": false
},
"reportId": {
"type": "string",
"minLength": 1
}
},
"required": [
"found",
"reportId"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"columnCount": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"endRow": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"filename": {
"type": "string"
},
"format": {
"type": "string",
"const": "csv"
},
"found": {
"type": "boolean",
"const": true
},
"hasMore": {
"type": "boolean"
},
"header": {
"type": "string"
},
"limit": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"reportId": {
"type": "string",
"minLength": 1
},
"returnedRowCount": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"rowCount": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"rows": {
"type": "array",
"items": {
"type": "object",
"properties": {
"csv": {
"type": "string"
},
"rowNumber": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"csv",
"rowNumber"
],
"additionalProperties": false
}
},
"startRow": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"endRow",
"format",
"found",
"hasMore",
"header",
"limit",
"reportId",
"returnedRowCount",
"rowCount",
"rows",
"startRow"
],
"additionalProperties": false
}
]
}Get tool call detailsget_tool_call_details
Get full details of a previous tool call by ID
- Dostawca
- hombee
- Uprawnienie
- user
- Wymagane możliwości
- chat.read
Adnotacje bezpieczeństwa
- Tylko do odczytu: Tak
- Destrukcyjne: Nie
- Idempotentne: Tak
- Otwarty świat: Nie
Schemat wejścia
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"callId": {
"type": "string",
"description": "The ID of the tool call to retrieve"
}
},
"required": [
"callId"
],
"additionalProperties": false
}Schemat wyjścia
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"anyOf": [
{
"type": "object",
"properties": {
"callId": {
"type": "string",
"minLength": 1
},
"found": {
"type": "boolean",
"const": false
}
},
"required": [
"callId",
"found"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"callId": {
"type": "string",
"minLength": 1
},
"found": {
"type": "boolean",
"const": true
},
"name": {
"type": "string",
"minLength": 1
},
"params": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/$defs/__schema0"
}
},
"timestamp": {
"type": "number"
},
"type": {
"type": "string",
"const": "tool_call"
}
},
"required": [
"callId",
"found",
"name",
"params",
"timestamp",
"type"
],
"additionalProperties": false
},
{
"type": "object",
"properties": {
"callId": {
"type": "string",
"minLength": 1
},
"error": {
"type": "string"
},
"found": {
"type": "boolean",
"const": true
},
"result": {
"$ref": "#/$defs/__schema0"
},
"timestamp": {
"type": "number"
},
"type": {
"type": "string",
"const": "tool_result"
}
},
"required": [
"callId",
"found",
"timestamp",
"type"
],
"additionalProperties": false
}
],
"$defs": {
"__schema0": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
},
{
"type": "number"
},
{
"type": "string"
},
{
"type": "array",
"items": {
"$ref": "#/$defs/__schema0"
}
},
{
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"$ref": "#/$defs/__schema0"
}
}
]
}
}
}Update memoryupdate_memory
Update the long-term memory with new facts
- Dostawca
- hombee
- Uprawnienie
- user
- Wymagane możliwości
- chat.configure
Adnotacje bezpieczeństwa
- Tylko do odczytu: Nie
- Destrukcyjne: Tak
- Idempotentne: Tak
- Otwarty świat: Nie
Schemat wejścia
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"action": {
"type": "string",
"enum": [
"add",
"remove",
"update"
],
"description": "Memory update action"
},
"content": {
"type": "string",
"description": "Content to add or update"
},
"force": {
"description": "Force update even if over token limit",
"default": false,
"type": "boolean"
},
"section": {
"description": "Section header (e.g., \"Room Mappings\", \"Preferences\")",
"type": "string"
}
},
"required": [
"action",
"content"
],
"additionalProperties": false
}Schemat wyjścia
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"action": {
"type": "string",
"enum": [
"add",
"remove",
"update"
]
},
"estimatedTokens": {
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
"success": {
"type": "boolean",
"const": true
},
"wasConsolidated": {
"type": "boolean"
}
},
"required": [
"action",
"estimatedTokens",
"success",
"wasConsolidated"
],
"additionalProperties": false
}installation
Remove hombee installation memberremove_hombee_installation_member
Remove a Hombee installation member while protecting the last installation owner
- Dostawca
- hombee
- Uprawnienie
- user
- Wymagane możliwości
- installation.operate
Adnotacje bezpieczeństwa
- Tylko do odczytu: Nie
- Destrukcyjne: Tak
- Idempotentne: Tak
- Otwarty świat: Nie
Schemat wejścia
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"expectedVersion": {
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"idempotencyKey": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"reason": {
"type": "string",
"minLength": 1,
"maxLength": 500
},
"installationId": {
"type": "string",
"minLength": 1
},
"uid": {
"type": "string",
"minLength": 1
}
},
"required": [
"expectedVersion",
"idempotencyKey",
"reason",
"installationId",
"uid"
],
"additionalProperties": false
}Schemat wyjścia
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"access": {
"type": "object",
"properties": {
"accessVersion": {
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"accountStatus": {
"type": "string",
"enum": [
"active",
"suspended"
]
},
"displayName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"effectiveEmployeeRole": {
"anyOf": [
{
"type": "string",
"enum": [
"admin",
"staff"
]
},
{
"type": "null"
}
]
},
"email": {
"type": "string",
"minLength": 1
},
"emailVerified": {
"type": "boolean"
},
"explicitEmployeeRole": {
"anyOf": [
{
"type": "string",
"enum": [
"admin",
"staff"
]
},
{
"type": "null"
}
]
},
"identityClaimsVersion": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"memberships": {
"type": "array",
"items": {
"type": "object",
"properties": {
"addressSummary": {
"type": "string"
},
"customerRole": {
"type": "string",
"enum": [
"owner",
"member"
]
},
"installationId": {
"type": "string",
"minLength": 1
},
"installationStatus": {
"type": "string",
"enum": [
"planned",
"active",
"maintenance",
"archived"
]
},
"installationType": {
"type": "string",
"enum": [
"wood",
"energyStorageSystems",
"smartHome",
"hvac",
"solarRoofs",
"roof",
"smart",
"sauna",
"wifi",
"home",
"skylight",
"pipes",
"electric"
]
}
},
"required": [
"addressSummary",
"customerRole",
"installationId",
"installationStatus",
"installationType"
],
"additionalProperties": false
}
},
"roleSource": {
"type": "string",
"enum": [
"explicit_admin",
"hombee_domain",
"none"
]
},
"uid": {
"type": "string",
"minLength": 1
}
},
"required": [
"accessVersion",
"accountStatus",
"displayName",
"effectiveEmployeeRole",
"email",
"emailVerified",
"explicitEmployeeRole",
"identityClaimsVersion",
"memberships",
"roleSource",
"uid"
],
"additionalProperties": false
},
"changed": {
"type": "boolean"
},
"replayed": {
"type": "boolean"
}
},
"required": [
"access",
"changed",
"replayed"
],
"additionalProperties": false
}Upsert hombee installation memberupsert_hombee_installation_member
Add or change a Hombee installation member; allowed for Hombee employees and installation owners
- Dostawca
- hombee
- Uprawnienie
- user
- Wymagane możliwości
- installation.operate
Adnotacje bezpieczeństwa
- Tylko do odczytu: Nie
- Destrukcyjne: Tak
- Idempotentne: Tak
- Otwarty świat: Nie
Schemat wejścia
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"expectedVersion": {
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"idempotencyKey": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"reason": {
"type": "string",
"minLength": 1,
"maxLength": 500
},
"installationId": {
"type": "string",
"minLength": 1
},
"role": {
"type": "string",
"enum": [
"owner",
"member"
]
},
"uid": {
"type": "string",
"minLength": 1
}
},
"required": [
"expectedVersion",
"idempotencyKey",
"reason",
"installationId",
"role",
"uid"
],
"additionalProperties": false
}Schemat wyjścia
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"access": {
"type": "object",
"properties": {
"accessVersion": {
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"accountStatus": {
"type": "string",
"enum": [
"active",
"suspended"
]
},
"displayName": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"effectiveEmployeeRole": {
"anyOf": [
{
"type": "string",
"enum": [
"admin",
"staff"
]
},
{
"type": "null"
}
]
},
"email": {
"type": "string",
"minLength": 1
},
"emailVerified": {
"type": "boolean"
},
"explicitEmployeeRole": {
"anyOf": [
{
"type": "string",
"enum": [
"admin",
"staff"
]
},
{
"type": "null"
}
]
},
"identityClaimsVersion": {
"anyOf": [
{
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
},
{
"type": "null"
}
]
},
"memberships": {
"type": "array",
"items": {
"type": "object",
"properties": {
"addressSummary": {
"type": "string"
},
"customerRole": {
"type": "string",
"enum": [
"owner",
"member"
]
},
"installationId": {
"type": "string",
"minLength": 1
},
"installationStatus": {
"type": "string",
"enum": [
"planned",
"active",
"maintenance",
"archived"
]
},
"installationType": {
"type": "string",
"enum": [
"wood",
"energyStorageSystems",
"smartHome",
"hvac",
"solarRoofs",
"roof",
"smart",
"sauna",
"wifi",
"home",
"skylight",
"pipes",
"electric"
]
}
},
"required": [
"addressSummary",
"customerRole",
"installationId",
"installationStatus",
"installationType"
],
"additionalProperties": false
}
},
"roleSource": {
"type": "string",
"enum": [
"explicit_admin",
"hombee_domain",
"none"
]
},
"uid": {
"type": "string",
"minLength": 1
}
},
"required": [
"accessVersion",
"accountStatus",
"displayName",
"effectiveEmployeeRole",
"email",
"emailVerified",
"explicitEmployeeRole",
"identityClaimsVersion",
"memberships",
"roleSource",
"uid"
],
"additionalProperties": false
},
"changed": {
"type": "boolean"
},
"replayed": {
"type": "boolean"
}
},
"required": [
"access",
"changed",
"replayed"
],
"additionalProperties": false
}