Skip to content

krohrbaugh/kramer-homeassistant

Repository files navigation

Kramer Integration

GitHub Release GitHub Activity License

Project Maintenance

Community Forum

Home Assistant integration for Kramer media switches via TCP.

This integration will set up the following platforms.

Platform Description
media_player Select media source.

Installation

Prerequisites

Before installing the integration in Home Assistant (HA), you'll need to:

  1. Confirm that your Kramer switch uses Protocol 2000 for its control protocol. This should be outlined in your device's manual.
  2. Ensure that your Kramer switch is assigned a static IP by your router.
  3. Ensure that your Kramer switch is configured to use that static IP. Most switches are not configured to use DHCP by default, and require configuring via software (e.g., KLAN Configurator). This should also be outlined in your device's manual.
  4. Ensure that your Kramer switch is reachable via the IP that you have configured for it.
ping $IP_OF_SWITCH

# Success :)
# PING $IP_OF_SWITCH ($IP_OF_SWITCH): 56 data bytes
# 64 bytes from $IP_OF_SWITCH: icmp_seq=0 ttl=100 time=1.139 ms
# 64 bytes from $IP_OF_SWITCH: icmp_seq=1 ttl=100 time=1.121 ms

# Failure :(
# PING $IP_OF_SWITCH ($IP_OF_SWITCH): 56 data bytes
# Request timeout for icmp_seq 0
# Request timeout for icmp_seq 0

Install the integration in Home Assistant

HACS custom repo

  1. From the Home Assistant Community Store (HACS) page, click the triple-dot menu in the top-right, and select "Custom repositories".
  2. Enter the URL to this repository, and select "Integration" in the category drop-down. Click "Add".
  3. The window will reload and show "Kramer Integration" with a trash can next to it. This means the custom repository has been added. Close the "Custom repositories" dialog.
  4. In the search box, enter "Kramer", and click on the integration to load the description.
  5. Click "Download" in the lower right corner, then confirm the download in the dialog that appears.
  6. The integration files should download to custom_components/kramer.
  7. Restart Home Assistant to activate the integration.

Manual install

  1. Using your tool of choice, open the directory (folder) for your HA configuration (where you find configuration.yaml).
  2. If you do not have a custom_components directory (folder) there, you need to create it.
  3. In the custom_components directory (folder) create a new folder called kramer.
  4. Download all the files from the custom_components/kramer/ directory (folder) in this repository.
  5. Place the files you downloaded in the new directory (folder) you created.
  6. Restart Home Assistant

Configuration of a device is done in the UI

  1. In the HA UI go to "Settings" -> "Devices & Services", then click "+ Add Integration" and search for "Kramer"

  2. Click on Kramer, and the device configuration form appears.

  3. Fill out the form, providing a name for the Kramer switch, and the IP address you configured for it.

    Figure 1: New device configuration form.

  4. Click "Submit" to create the device. If successful, HA will ask what Area to assign the device to.

Device operation

  1. Click on the Kramer integration to view configured devices.

  2. Click the device link under the name of the Kramer switch to view the device information page.

    Figure 2: Configured device information page.

  3. Click on the device name under the "Controls" section to show the source selection dialog. Select an input from the list and confirm that your switch changed inputs.

    Figure 3: Device source selection interface.

Once you've confirmed that your switch is working correctly, consider adding source selection to some of your automations, such as part of a universal remote control activity.

Contributions welcome

If you want to contribute to this please read the Contribution guidelines.