Skip to content

ws/hass-tryfi

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

TryFi for Home Assistant (@ws fork)

beta_badge release_date hacs_badge

This allows you to integrate TryFi Smart GPS Collars with Home Assistant.

Features

Current functionality includes:

  • Device Tracker - your pet will show up in HA using the GPS coordinates from the collar
  • Step Counter - it will report your pets daily, weekly, and monthly steps
  • Distance Counter - it will report your pets daily, weekly and monthly distance
  • Battery Level - it will report your Pet's collar battery level
  • Battery Charging - it will report if your Pet's collar is charging
  • Collar Light - you can control the light on the collar by turning it on and off (color selection coming soon!)
  • Lost Dog Mode - allows you to select Lost mode if your dog if it is lost and select Safe if it is found
  • Bases - reports the status of the base (online/offline)

Donate

If you would like to donate you can use my TryFi referral code "395FX4" on your next purchase.

Installation

Pre-Requisities

  • Home Assistant >= 2023.1.0
  • TryFi dog collar with active cellular subscription
  • HACS is already installed

Installation Methods

HACS Install

  1. Search for TryFi under Integrations in the HACS Store tab.
  2. Add the Integration to your HA and configure.

Manual Install

  1. In your /config directory, create a custom_components folder if one does not exist.
  2. Copy the tryfi folder and all of it's contents to your custom_components directory.
  3. Restart Home Assistant.
  4. Add the Integration to your HA and configure.

Configuration

  1. After installing TryFi go to Configuration --> Integrations and add a new Integration
  2. Search for TryFi
  3. Enter in your TryFi username and password. Optionally you can select a polling frequency option (in seconds). Suggestion is nothing less then 5.
  4. Click Submit

Setup

Validation

Once you have added the integration, you will see 1 or more devices and entities associated with this integration. To validate its accuracy, you can review the steps and distance counters for your pet or its current whereabouts.

Integration

Dog Device and Entities

Device

Dog Device

Entities

Dog Entities

Base Device and Entities

Base Device and Entities

How to Use

Light Collar

The light on your Pet's collar is represented as a light switch in HA. It can either be turned on or off.

Lovelace

Lost Dog Mode

TryFi is equiped with a "Lost Dog Mode" functionality. In HA this is represented by a select entity. Select Lost if your pet is lost or Safe if your pet is OK.

Lovelace

Lovelace

Entities

type: entities
entities:
  - entity: select.harley_lost_state
  - entity: sensor.harley_collar_battery_level
  - entity: binary_sensor.harley_collar_battery_charging
  - entity: sensor.home_base
  - entity: sensor.harley_daily_steps
  - entity: sensor.harley_weekly_steps
  - entity: sensor.harley_monthly_steps
  - entity: sensor.harley_daily_distance
  - entity: sensor.harley_weekly_distance
  - entity: sensor.harley_monthly_distance
  - entity: sensor.harley_daily_sleep
  - entity: sensor.harley_weekly_sleep
  - entity: sensor.harley_monthly_sleep
  - entity: sensor.harley_daily_nap
  - entity: sensor.harley_weekly_nap
  - entity: sensor.harley_monthly_nap

Light

type: light
entity: light.harley_collar_light

Automation Examples

Turn on the Collar Light After Dark

Turns on the collar light after dark if the pet is not home.

- id: '1604060166498'
  alias: Turn on Light After Dark If Not Home
  description: ''
  trigger:
  - platform: sun
    event: sunset
  condition:
  - condition: and
    conditions:
    - condition: device
      device_id: a7237a6c1144fcd90828b21de2572603
      domain: device_tracker
      entity_id: device_tracker.pet_tracker
      type: is_not_home
  action:
  - type: turn_on
    device_id: a7237a6c1144fcd90828b21de2572603
    entity_id: light.pet_collar_light
    domain: light
  mode: single

Fully Charged Notification

Sends notification when battery has charged to 100%.

- id: '1661129896868'
  alias: Pet's Collar - Fully Charged
  description: ''
  trigger:
  - platform: state
    entity_id:
    - sensor.pet_collar_battery_level
    to: '100'
    for:
      hours: 0
      minutes: 0
      seconds: 0
  condition:
  - condition: state
    entity_id: binary_sensor.pet_collar_battery_charging
    state: 'on'
  action:
  - service: notify.everyone_phone
    data:
      message: Pet's collar is fully charged!
  mode: single

Known Issues

  • It sometimes takes time for the status to accurately refresh in HA. For example the light on/off status and the Lost Mode select status.

Future Enhacements

  • Allow for the selection of the LED light color
  • Enable possibility of if pet not home and not with owner then trigger lost dog mode

Version History

  • Fix - Due to recent changes by TryFi, additional changes were required in the pytryfi library. Bumping version to include those changes/fixes.

0.0.19

  • Fix - pets without collars were causing errors.

0.0.18

  • Enhancement - Battery Charging - it will report if your Pet's collar is charging

0.0.17

  • Enhancement - added the attribute ConnectedTo which will determine if the pet is connected to a person, base, etc.
  • Fix - base data was not updating. This issue is resolved.

0.0.16

  • Enhancement - requested to add the attributes Activity Type, Current Place Name and Current Place Address.

0.0.15

  • Version bump to support latest pytryfi version 0.0.16 that includes multiple households

0.0.14

  • Fix - fixed sleep and nap units from hours to minutes with proper conversion

0.0.13

  • Enhancement - Added Sleep and Nap "sensors"/attributes based on new version of pytryfi

0.0.12

  • Fix - Issue where base status (online/offline) was not set correctly.

0.0.11

  • Version bump to support latest pytryfi version 0.0.14.1

0.0.10

  • Lost Mode is now a select entity instead of a lock entity

0.0.9

  • Updated dependency version of pytryfi
  • Fixed Issue #30 - Convert to Async

0.0.8

  • Updating dependency version of pytryfi

0.0.7

  • Updating dependency version of pytryfi

0.0.6

  • Steps unit was added to enable charting of dogs steps over time.

0.0.5

0.0.4

0.0.3

  • Multiple bases fix

0.0.2

  • Documentation updates

0.0.1

  • Initial Release with basic functionality including light on/off, device tracker, lock mode of dog and general stats

Links

About

Home Assistant integration for TryFi Dog Collar GPS monitoring.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 100.0%