Skip to content
Download

HA Backend Integration

The TappRFID backend integration connects your HA instance to the TappRFID cloud. Once installed and authenticated, HA creates sensor entities for every task and log in your account. You can use these sensors in dashboards, automations, and scripts — and optionally trigger task completions back from HA.

  • Active TappRFID cloud subscription
  • Cloud sync enabled in the app (see Cloud Sync)
  • Home Assistant 2023.4 or later
  • HACS installed for the recommended install path

HACS lets you install and update the integration from the HA UI without touching the filesystem.

  1. Open Home Assistant and go to HACS in the sidebar.
  2. Click Integrations.
  3. Click the three-dot menu (⋮) in the top right and choose Custom repositories.
  4. In the Repository field, enter:
    https://github.com/mrcpuddington/tap-home-assistant-integration
  5. Set Category to Integration and click Add.
  6. Close the dialog. Search for TappRFID in HACS Integrations.
  7. Click TappRFIDDownload → confirm the version and click Download again.
  8. Restart Home Assistant — the integration won’t appear until HA restarts.

Use this if you prefer not to use HACS or can’t install it.

  1. Go to the TappRFID integration repository on GitHub and download the latest release ZIP from the Releases section.
  2. Extract the ZIP. Inside you’ll find a folder named tap_rfid.
  3. Copy the tap_rfid folder into your HA config directory:
    /config/custom_components/tap_rfid/
    The result should look like:
    /config/
    └── custom_components/
    └── tap_rfid/
    ├── __init__.py
    ├── manifest.json
    ├── sensor.py
    └── ...
  4. Restart Home Assistant.

After installing and restarting:

  1. In Home Assistant, go to Settings → Devices & Services.
  2. Click + Add Integration (bottom right).
  3. Search for TappRFID and select it.
  4. A browser window opens for OAuth sign-in. Use the same account credentials as in the TappRFID app.
  5. Authorise the connection. You’ll be redirected back to HA.
  6. The integration appears as connected with a device entry.

In TappRFID: Settings → Home Assistant → Verify Home Assistant Connection.

You should see a success message. If not, check the troubleshooting section below.


Once connected, HA creates sensor entities for every task and log in your account. Entities update in near real-time as you make changes in the app.

Each task creates one sensor:

sensor.tapprfid_<task_name>

States:

StateMeaning
overduePast due — the task hasn’t been completed in time
due_soonDue within the next few hours (configurable threshold)
on_trackCompleted recently, next due date is in the future
completeCompleted today (for daily tasks)
unavailableEntity can’t be reached — check connection

Attributes:

AttributeTypeDescription
task_idstringUUID — use this in service calls
last_completeddatetimeWhen the task was last completed
streakintegerCurrent consecutive completion streak
next_duedatetimeWhen the task is next due
interval_daysfloatRecurrence interval
friendly_namestringDisplay name from the app

Each log creates one sensor:

sensor.tapprfid_log_<log_name>

States: Timestamp of the most recent log entry (ISO 8601 string), or unknown if no entries exist.

Attributes:

AttributeTypeDescription
log_idstringUUID — use this in service calls
entry_countintegerTotal number of entries
last_notestringNote text from the most recent entry (if any)
friendly_namestringDisplay name from the app

Service calls let HA trigger actions back in TappRFID — completing tasks, reopening them, or adding log entries. These actions sync to the app within seconds.

service: tap_rfid.complete_task
data:
task_id: "YOUR_TASK_UUID"

Marks the task complete with the current timestamp. This is equivalent to tapping the task in the app.

service: tap_rfid.reopen_task
data:
task_id: "YOUR_TASK_UUID"

Removes the most recent completion, marking the task as incomplete. Use this if you accidentally completed a task.

service: tap_rfid.add_log_entry
data:
log_id: "YOUR_LOG_UUID"
note: "Optional note text"

Adds an entry to a log. The note field is optional.

  • In Home Assistant: open the entity, go to the Attributes section, copy task_id or log_id.
  • In the TappRFID app: open the task or log detail screen — the UUID is shown at the bottom under the debug section (Settings → Debug must be enabled).

In TappRFID: Settings → Home Assistant:

OptionDefaultDescription
Enable HA SensorsOnCreates and updates sensor entities in HA
Enable HA ActionsOffAllows service calls to complete/reopen tasks and add log entries
Due Soon Threshold2 hoursHow far in advance a task enters due_soon state

Read-only mode: Leave Enable HA Actions off if you want sensor data in dashboards without allowing HA to write back to your tasks.


HACS will show a pending update when a new version is available. Go to HACS → Integrations → TappRFID and click Update. Restart HA after updating.

Download the new release ZIP, replace the tap_rfid folder in /config/custom_components/, and restart HA.


Integration not appearing after install:

  • Confirm you restarted HA after installing.
  • Check /config/custom_components/tap_rfid/ exists and contains manifest.json.
  • Clear your browser cache if using the web UI.

Authentication fails or redirects incorrectly:

  • Confirm your cloud account is connected and active in the TappRFID app.
  • Try removing the integration (Settings → Devices & Services → TappRFID → Delete) and re-adding it.
  • Check that your HA instance has outbound internet access.

Entities show unavailable:

  • In TappRFID: Settings → Home Assistant → Verify Connection.
  • Check cloud sync is running: Settings → Cloud Account.
  • Review HA logs: Settings → System → Logs → filter for tap_rfid.

Service call fails with “unknown service”:

  • Confirm Enable HA Actions is on in the app.
  • Confirm the integration is connected (not just installed).
  • Reload the integration: Settings → Devices & Services → TappRFID → ⋮ → Reload.

Entities not updating after app changes:

  • The integration polls every 30 seconds by default. Wait up to a minute.
  • Trigger a manual sync in the app: pull-to-refresh on any screen.
  • Check Settings → Debug → Sync log in the app for errors.

For dashboard display, see the Lovelace Card docs. For automation examples, see Automations.