2024.10.4
Home ▸ Integrations ▸

Switcher

This Switcher integration allows you to control your Switcher Devices.

Supported devices:

  • Switcher Power Plug
  • Switcher Touch (from firmware 1.51)
  • Switcher V2 (Espressif chipset - from firmware 3.21)
  • Switcher V2 (Qualcomm chipset - from firmware 72.32)
  • Switcher V4
  • Switcher Mini
  • Switcher Breeze
  • Switcher Runner
  • Switcher Runner S11

Devices that require a token:

  • Switcher Runner S11

If you completed the integration setup but are still unable to control the device, please make sure your device’s firmware is up-to-date.

Prerequisites

To enhance security, certain Switcher devices require a token for operation. In order to integrate your token-based Switcher devices with Home Assistant, you’ll need the following information:

  • The username of your Switcher Account: To find the username, open the Switcher app.

  • Local control key token: To find the local control key token, browse to the Switcher GetKey API, enter your Switcher account username (which is an email address), and press Send Me The Code.

    The token will be sent to you by email. It will look something like this: zvVvd7JxtN7CgvkD1Psujw==

Configuration

To add the Switcher integration to your Home Assistant instance, use this My button:

Manual configuration steps

If the above My button doesn’t work, you can also perform the following steps manually:

  • Browse to your Home Assistant instance.

  • Go to Settings > Devices & Services.

  • In the bottom right corner, select the Add Integration button.

  • From the list, select Switcher.

  • Follow the instructions on screen to complete the setup.

Buttons

For Switcher Breeze the integration provides the following buttons:

  • For devices that are also controlled in other ways or often go out of sync with Switcher Breeze, there are Assume on & Assume off buttons which you can use to can tell Switcher Breeze if your device is currently running or not without sending a new command to the device.

  • For devices which do not support swing status for the vertical swing, the integration provides separate Vertical swing on & Vertical swing off buttons.

Sensors

For Switcher power control devices (Switcher Power Plug, Switcher Touch, Switcher V2/V4) the integration provides the following sensors:

Sensor Name Description Example
Auto Shutdown* The auto shutdown time limit configured on the device 01:30:00
Remaining Time* Time remaining to shutdown (auto or timer) 01:29:41
Electric Current The electric current in amps 12.5 A
Power Consumption The power consumption in watts 2756 W

*Currently not supported for Switcher Power Plug

Actions

For Switcher power control devices (Switcher Touch, Switcher V2/V4) the integration provides the following sensors:

Action: switcher_kis.set_auto_off

You can use the switcher_kis.set_auto_off action to set the auto-off configuration setting for the device.

Meaning the device will turn itself off when reaching the auto-off configuration limit.

Data attribute Mandatory Description Example
entity_id Yes Name of the entity id associated with the integration, used for permission validation switch.switcher_kis_boiler
auto_off Yes Time period string containing hours and minutes “02:30”

Action: switcher_kis.turn_on_with_timer

You can use the switcher_kis.turn_on_with_timer action to turn on the switcher device with timer.

Meaning the device will turn itself off when timer ends. Note: This does not affect the auto off timer.

Data attribute Mandatory Description Example
entity_id Yes Name of the entity id associated with the integration, used for permission validation switch.switcher_kis_boiler
timer_minutes Yes Integer containing timer minutes (valid range 1 to 150) 90

Notes

Make sure that Home Assistant host’s firewall allows incoming traffic on UDP ports 10002, 10003, 20002 & 20003 and outgoing connections to Switcher device(s) on TCP ports 9957 & 10000. If Home Assistant and the Switcher device(s) are not on the same network, you will also need to have their traffic properly forwarded between the two networks.