Configuration - martindybal/taphome-homeassistant GitHub Wiki

Basic setup

You need to expose the devices via TapHome API. To add the TapHome API interface in TapHome app you have to go to Settings -> Shared devices -> Add new interface -> TapHome API.

Then choose the devices that you want to expose to Home Assistant using the Add device option.

Every exposed device has a numeric id, you have to take these ids, the authorization token at top of the screen and insert in Home Assistant integration configuration file as show below. Do not share your token anywhere!. For your convenience I prepared config generator. You will only need the token and cloud access allowed during generation.

Local access

The prefered way is local access. You have to provide api_url in your config. Format is http://{Your_Core_IP}/api/cloudapi/v1. Make sure that your core Ip address'll not change in the future. If you don't provide an api_url the cloud api is used https://cloudapi.taphome.com/api/cloudapi/v1 so you need an stable internet connection.

taphome:
  cores:
    - token: 00000000-0000-0000-0000-000000000000
      api_url: http://192.168.0.2/api/cloudapi/v1

Switches

Switches can be add like this:

taphome:
  cores:
    - token: 00000000-0000-0000-0000-000000000000
      api_url: http://192.168.0.2/api/cloudapi/v1
      switches:
        - 6
        - 7

Lights

Lights (switch, dimmable or RGB) can be add like this:

taphome:
  cores:
    - token: 00000000-0000-0000-0000-000000000000
      api_url: http://192.168.0.2/api/cloudapi/v1
      lights:
        - 1
        - 2
        - 5

Covers

Blinds, shades or garage doors can be add like this:

taphome:
  cores:
    - token: 00000000-0000-0000-0000-000000000000
      api_url: http://192.168.0.2/api/cloudapi/v1
      covers:
        - 3
        - 4

Climates

Thermostats can be add like this:

taphome:
  cores:
    - token: 00000000-0000-0000-0000-000000000000
      api_url: http://192.168.0.2/api/cloudapi/v1
      climates:
        - 8
        - 9
        - 10

You can also use HVAC control. You can heating_cooling_mode_id, heating_switch_id or cooling_switch_id. Where heating_switch_id or cooling_switch_id is switch which turn heating/cooling turn off and on. A heating_cooling_mode_id is multivalue switch

Value	Mode
0	Off
1	Heating
2	Cooling
3	Heating or Cooling

taphome:
  cores:
    - token: 00000000-0000-0000-0000-000000000000
      api_url: http://192.168.0.2/api/cloudapi/v1
      climates:
        - thermostat: 8
          cooling_switch_id: 11
        - thermostat: 9
          heating_switch_id: 12
        - thermostat: 10
          heating_cooling_mode_id: 13

Sensors

There is two type of sensors. A sensor is a read-only entity that provides some information. A binary sensor is a sensor that can only have two states (1/0). TapHome variable can be use as sensor or binary sensor.

taphome:
  cores:
    - token: 00000000-0000-0000-0000-000000000000
      api_url: http://192.168.0.2/api/cloudapi/v1
      sensors:
        - 8
      binary_sensors:
        - 18

Multiple core units

You can use multiple TapHome core units in your installation. In these cases you can use config like this:

taphome:
  cores:
    - token: 00000000-0000-0000-0000-000000000000
      api_url: http://192.168.0.2/api/cloudapi/v1
      lights:
        - 1
        - 2
    - token: 00000000-0000-0000-0000-000000000000
      api_url: http://192.168.0.2/api/cloudapi/v1
      lights:
        - 1
      covers:
        - 6

Sample configuration

taphome:
  cores:
    - token: 00000000-0000-0000-0000-000000000000
      api_url: http://192.168.0.2/api/cloudapi/v1
      lights:
        - 1
      covers:
        - 3
      climates:
        - thermostat: 14
          mode: 13
      switches:
        - 13
      sensors:
        - 8
      binary_sensors:
        - 18