Skip to content

Companion Integration

The TaskerHA Companion is an optional Home Assistant custom integration that unlocks richer features inside the Android app and provides a clean UI for bidirectional messaging.

What it provides

FeatureWithout companionWith companion
Targeting (service calls)Entity ID's onlyEntity ID's, Areas, devices, and labels
Send message to HARaw taskerha_message_back eventDevice trigger with filter UI
Send message from HAListen for raw taskerha_message eventsend_taskerha_message service action with UI

Installation

Via HACS (recommended)

  1. Make sure HACS is installed.
  2. Open HACS repository
    Click the badge above → AddInstall.
  3. Restart Home Assistant.
  4. Go to Settings → Integrations and add TaskerHA Companion.

Manual

  1. Copy the custom_components/taskerha_companion/ folder from the HACS repo into your HA config/custom_components/ directory.
  2. Restart Home Assistant.
  3. Add the integration under Settings → Integrations.

No configuration options are required — just add it and restart.


Registry data (areas, devices, labels)

Once installed, the app calls the taskerha_companion.get_registry_data service when loading entity pickers. This returns your HA organization data so the app can:

  • Show a Label filter in entity pickers
  • Show an Area filter in entity pickers
  • Allow targeting by area, device, or label when calling services (matching how HA's own UI works)
Entity picker with area and label filters
Entity picker — filter by label or area when the companion is installed

This service is called automatically by the app — you do not need to call it manually.


Sending messages from Home Assistant to Tasker

Use the taskerha_companion.send_taskerha_message HA service to push a message to a Tasker profile on the device.

In a Home Assistant automation

yaml
action:
  - action: taskerha_companion.send_taskerha_message
    data:
      type: lights_off
      message: good_night

Both type and message are optional strings. Leave either blank to send without that field.

The service fires a taskerha_message event on the HA event bus. The TaskerHA app listens for this over WebSocket and delivers it to the matching On HA Message profile.

WebSocket required

The app must have WebSocket enabled to receive messages. See the WebSocket guide.

See Direct Message from HA for how to configure the receiving profile in Tasker.


Receiving messages from Tasker in Home Assistant

When the HA Send Message Back Tasker action runs, the app fires a taskerha_message_back event. With the companion integration installed you can react to this via a device trigger instead of a raw event listener.

Setting up the device trigger

  1. Create a new automation in HA.
  2. Add a trigger → Device → select your TaskerHA Companion device.
  3. Trigger type: Receive message from TaskerHA.
  4. Optionally fill in Type filter and/or Message filter to only fire for specific messages.

The trigger data available in templates:

Template variableDescription
trigger.type_valueThe type sent from Tasker.
trigger.messageThe message sent from Tasker.

Without the companion integration

If you prefer not to use the companion, listen for the raw event:

yaml
trigger:
  - trigger: event
    event_type: taskerha_message_back
    event_data:
      type: my_type       # optional filter
      message: my_message # optional filter

See Send Message to HA for how to configure the sending action in Tasker.

Released under the MIT License.