# Example configuration.yaml entry configuring HomeKit
homekit:
  - filter:
      include_domains:
        - alarm_control_panel
        - light
        - media_player
      include_entity_globs:
        - binary_sensor.*_occupancy
      include_entities:
        - binary_sensor.living_room_motion
    entity_config:
      alarm_control_panel.home:
        code: 1234
      binary_sensor.living_room_motion:
        linked_battery_sensor: sensor.living_room_motion_battery
        low_battery_threshold: 31
      fan.air_purifier:
        type: air_purifier
        linked_filter_life_level_sensor: sensor.air_purifier_filter_life_level
      light.kitchen_table:
        name: Kitchen Table Light
      lock.front_door:
        code: 1234
      media_player.living_room:
        feature_list:
          - feature: on_off
          - feature: play_pause
          - feature: play_stop
          - feature: toggle_mute
      switch.bedroom_outlet:
        type: outlet
      camera.back_porch:
        support_audio: True
      sensor.some_co_sensor:
        co_threshold: 1000
      sensor.some_co2_sensor:
        co2_threshold: 1000
  - name: HASS Bridge 2
    port: 21065
    filter:
      include_domains:
        - light

homekit:
  description: HomeKit configuration.
  required: true
  type: map
  keys:
    port:
      description: Port for the HomeKit extension. If you are adding more than one instance they need to have different values for port.
      required: false
      type: integer
      default: 21063
    name:
      description: Needs to be unique for each instance of Home Assistant using the integration on the same local network. Between `3` and `25` characters. Alphanumeric and spaces allowed.
      required: false
      type: string
      default: '`Home Assistant Bridge`'
    ip_address:
      description: The local network IP address. Only necessary if the default from Home Assistant does not work.
      required: false
      type: string
    mode:
      description: HomeKit can expose an entity via a bridge, or a single entity as an accessory which is needed for Television Media Players. ([Accessory mode](#accessory-mode))
      required: false
      type: string
      default: '`bridge`'
    advertise_ip:
      description: If you need to override the IP address(es) used for mDNS advertisement. (For example, using network isolation in Docker and together with an mDNS forwarder like `avahi-daemon` in reflector mode)
      required: false
      type: list
    filter:
      description: Filters for entities to be included/excluded from HomeKit. ([Configure Filter](#configure-filter))
      required: false
      type: map
      keys:
        include_domains:
          description: Domains to be included.
          required: false
          type: list
        include_entity_globs:
          description: Include all entities matching a listed pattern (e.g., `binary_sensor.*_motion`).
          required: false
          type: list
        include_entities:
          description: Entities to be included.
          required: false
          type: list
        exclude_domains:
          description: Domains to be excluded.
          required: false
          type: list
        exclude_entity_globs:
          description: Exclude all entities matching a listed pattern (e.g., `sensor.*_motion`).
          required: false
          type: list
        exclude_entities:
          description: Entities to be excluded.
          required: false
          type: list
    entity_config:
      description: Configuration for specific entities. All subordinate keys are the corresponding entity ids of the domains, e.g., `alarm_control_panel.alarm`.
      required: false
      type: map
      keys:
        '`ENTITY_ID`':
          description: Additional options for specific entities.
          required: false
          type: map
          keys:
            name:
              description: Name of the entity to show in HomeKit. HomeKit will cache the name on the first run so the accessory must be [reset](#resetting-accessories) for any change to take effect.
              required: false
              type: string
            linked_battery_sensor:
              description: The `entity_id` of a `sensor` entity to use as the battery of the accessory.
              required: false
              type: string
            linked_doorbell_sensor:
              description: The `entity_id` of a `binary_sensor` or `event` entity to use as the doorbell sensor of a `lock` or `camera` accessory to enable doorbell notifications.
              required: false
              type: string
            linked_filter_change_indication_binary_sensor:
              description: The `entity_id` of a `binary_sensor` entity to use as the indicator that the filter of the air purifier accessory needs to be changed.
              required: false
              type: string
            linked_filter_life_level_sensor:
              description: The `entity_id` of a `sensor` entity to use as the filter life level of the air purifier accessory.
              required: false
              type: string
            linked_humidity_sensor:
              description: The `entity_id` of a `sensor` entity to use as the humidity sensor of the humidifier/dehumidifier accessory.
              required: false
              type: string
            linked_pm25_sensor:
              description: The `entity_id` of a `sensor` entity to use as the PM2.5 sensor of the air purifier accessory. When set, the `fan` accessory will default its `type` to `air_purifier`.
              required: false
              type: string
            linked_motion_sensor:
              description: The `entity_id` of a `binary_sensor` or `event` entity to use as the motion sensor of the camera accessory to enable motion notifications.
              required: false
              type: string
            linked_obstruction_sensor:
              description: The `entity_id` of a `binary_sensor` entity to use as the obstruction sensor of the garage door (cover) accessory to enable obstruction state tracking.
              required: false
              type: string
            linked_temperature_sensor:
              description: The `entity_id` of a `sensor` entity to use as the temperature sensor of the air purifier accessory.
              required: false
              type: string
            linked_valve_duration:
              description: The `entity_id` of an `input_number` entity to use as the default run time of a valve switch (switch type `faucet`, `shower`, `sprinkler`, or `valve`), or valve accessory. Minimum value, maximum value, and step size are set based on the linked `input_number` entity.
              required: false
              type: string
            linked_valve_end_time:
              description: The `entity_id` of a `sensor` (timestamp) entity to use for calculating the remaining time of a valve switch (switch type `faucet`, `shower`, `sprinkler`, or `valve`), or valve accessory. The end time has to be maintained in Home Assistant. HomeKit will not update the state of this sensor. The maximum value is set based on the `input_number` of `linked_valve_duration`, or uses a default of 48 hours.
              required: false
              type: string
            low_battery_threshold:
              description: Minimum battery level before the accessory starts reporting a low battery.
              required: false
              type: integer
              default: 20
            code:
              description: Code to `arm / disarm` an alarm or `lock / unlock` a lock. Only applicable for `alarm_control_panel` or `lock` entities.
              required: false
              type: string
              default: '`<No code>`'
            feature_list:
              description: Only for `media_player` entities. List of feature dictionaries to add for a given entity. Comparable to the platform schema.
              required: false
              type: list
              keys:
                feature:
                  description: Name of the feature to add to the entity representation. Valid features are `on_off`, `play_pause`, `play_stop` and `toggle_mute`. The media_player entity must support the feature to be valid.
                  required: true
                  type: string
            type:
              description: Only for `switch` and `fan` entities. Type of accessory to be created within HomeKit. Valid types for `switch` entities are `faucet`, `outlet`, `shower`, `sprinkler`, `switch` and `valve`. Valid types for `fan` entities are `fan` and `air_purifier`.
              required: false
              type: string
              default: '`switch`'
            stream_count:
              description: Only for `camera` entities. The number of simultaneous streams the camera can support.
              required: false
              type: integer
              default: 3
            stream_address:
              description: Only for `camera` entities. The source IP address to use when streaming to RTP clients. If your Home Assistant host has multiple interfaces, selecting a specific IP may be necessary.
              required: false
              type: string
              default: local IP from Home Assistant
            stream_source:
              description: Only for `camera` entities. A URL, file or other valid FFmpeg input string to use as the stream source, rather than the default camera source. Required for camera entities that do not natively support streaming (MJPEG). If `-i` is not found in the stream source, it is prepended to construct the FFmpeg input.
              required: false
              type: string
              default: stream source from camera entity
            support_audio:
              description: Only for `camera` entities. Whether the camera supports audio. Audio is disabled unless this flag is set to `True`.
              required: false
              type: boolean
              default: '`False`'
            max_width:
              description: Only for `camera` entities. Maximum width supported by camera. Used when generating advertised video resolutions.
              required: false
              type: integer
              default: 1920
            max_height:
              description: Only for `camera` entities. Maximum height supported by camera. Used when generating advertised video resolutions.
              required: false
              type: integer
              default: 1080
            max_fps:
              description: Only for `camera` entities. Maximum FPS (frames per second) supported by camera. Used when generating advertised video resolutions.
              required: false
              type: integer
              default: 30
            audio_map:
              description: Only for `camera` entities. FFmpeg [stream selection mapping](https://ffmpeg.org/ffmpeg.html#Stream-selection) for the audio-only stream. Selects the first audio stream in the input stream by default. If your input stream has multiple audio streams, this may need to be adjusted.
              required: false
              type: string
              default: '`0:a:0`'
            video_map:
              description: Only for `camera` entities. FFmpeg [stream selection mapping](https://ffmpeg.org/ffmpeg.html#Stream-selection) for the video-only stream. Selects the first video stream in the input stream by default. If your input stream has multiple video streams, this may need to be adjusted.
              required: false
              type: string
              default: '`0:v:0`'
            audio_packet_size:
              description: Only for `camera` entities. RTP packet size used for streaming audio to HomeKit clients.
              required: false
              type: integer
              default: 188
            video_packet_size:
              description: Only for `camera` entities. RTP packet size used for streaming video to HomeKit clients.
              required: false
              type: integer
              default: 1316
            video_codec:
              description: Only for `camera` entities. FFmpeg video codec for transcoding. `copy` option reduces CPU load when video source is already encoded with `H264` (MPEG4). `h264_v4l2m2m` can be used with supported hardware, e.g., the Raspberry Pi, to offload encoding to hardware. The `h264_omx` option is only available with custom FFmpeg builds and enables GPU Hardware acceleration on Raspberry Pi.
              required: false
              type: string
              default: libx264
              available options: copy, libx264, h264_v4l2m2m, h264_omx, h264_qsv
            video_profile_names:
              description: Only for `camera` entities. FFmpeg video profile names for transcoding, only relevant if `video_codec` isn't `copy`. Some encoders, e.g., the Raspberry Pi's `h264_v4l2m2m`, don't use the standard `["baseline", "main", "high"]` profile names but expects `["0", "2", "4"]` instead. Use this option to override the default names, if needed.
              required: false
              type: list
              default: ["baseline", "main", "high"]
            audio_codec:
              description: Only for `camera` entities. FFmpeg audio codec for transcoding. `copy` option reduces CPU load when audio source is already encoded with `libopus`.
              required: false
              type: string
              default: libopus
              available options: copy, libopus
            co_threshold:
              description: Only for `sensor` entities with `device_class` `carbon_monoxide`. Used as the threshold value once HomeKit will warn/notify the user.
              required: false
              type: integer
              default: 25
            co2_threshold:
              description: Only for `sensor` entities with `device_class` `carbon_dioxide` or `co2` in `entity_id`. Used as the threshold value once HomeKit will warn/notify the user.
              required: false
              type: integer
              default: 1000
    devices:
      description: Include device triggers for all matching device ids. Configuration in the UI via Options is recommended instead.
      required: false
      type: list                

# Example for HomeKit setup
homekit:

# Example filter to include specified domains and exclude specified entities
homekit:
  filter:
    include_domains:
      - alarm_control_panel
      - light
    include_entity_globs:
      - binary_sensor.*_occupancy
    exclude_entities:
      - light.kitchen_light

homekit:
  advertise_ip: "STATIC_IP_OF_YOUR_DOCKER_HOST"

automation:
  triggers:
    - trigger: event
      event_type: homekit_tv_remote_key_pressed
      event_data:
        key_name: arrow_right

  # Send the arrow right key via a broadlink IR blaster
  actions:
    - action: broadlink.send
      host: 192.168.1.55
      packet: XXXXXXXX

# Example for handling a HomeKit event
automation:
  triggers:
    - trigger: event
      event_type: homekit_state_change
      event_data:
        entity_id: cover.garage_door
        action: open_cover
  actions:
    - action: persistent_notification.create
      data:
        message: "The garage door got opened via HomeKit"

logger:
  default: warning
  logs:
    homeassistant.components.homekit: debug
    pyhap: debug

homekit:
  filter:
    include_entities:
      - demo.demo