home-assistant.io/source/_components/switchbot.markdown
manonstreet 41d5559aca Update Switchbot doc to match PR #25474 (#9976)
* Update Switchbot doc to match PR #25474

Add details on existing assumed_state attribute as well as the for the new last_run_success attribute

* ✏️ Tweaks
2019-07-28 20:07:16 +02:00

1.2 KiB

title, description, logo, ha_category, ha_release, ha_iot_class, redirect_from
title description logo ha_category ha_release ha_iot_class redirect_from
Switchbot Instructions on how to set up Switchbot switches. switchbot.png
Switch
0.78 Local Polling
/components/switch.switchbot/

The switchbot switch platform allows you to control Switchbot devices.

Manual Configuration

To enable it, add the following lines to your configuration.yaml:

switch:
  - platform: switchbot
    mac: 'MAC_ADDRESS'

{% configuration %} mac: description: The device MAC address with lower-case letters. required: true type: string name: description: The name used to display the switch in the frontend. required: false type: string {% endconfiguration %}

Switchbot Entity

There are two attributes available on the Switchbot entity to give you more information about your device.

  • last_run_success: If true if the last action sent to the Switchbot succeeded. This attribute is useful for error trapping when Bluetooth connectivity is intermittent. If false, see home-assistant.log for specific error messgages.
  • assumed_state: Always true. If the state of the Switchbot entity cannot be determined, it is assumed to be on.