Add Support for TryFi Series 3+ New Metrics

[adamjacobmuller]

Add Support for TryFi Series 3+ New Metrics

Overview

The TryFi Series 3+ collar includes new AI-powered behavior tracking features that are not currently exposed in the pytryfi library. This issue documents the new features and proposes adding support for them.

New Series 3+ Features

Based on TryFi's official documentation and research, the Series 3+ collar includes:

AI-Powered Behavior Tracking

• Barking detection - Track when and how often your dog barks
• Licking detection - Monitor excessive licking behaviors
• Scratching detection - Track scratching frequency
• Eating detection - Know when your dog is eating
• Drinking detection - Track water consumption patterns

Enhanced Metrics

• Signal strength indicators - Better connectivity information
• Enhanced GPS accuracy - 2x faster and more accurate tracking
• Sleep quality score - More detailed sleep analysis

Implementation Plan

1. New GraphQL Fragments Needed

We need to add new GraphQL fragments to query these behavior metrics:

fragment BehaviorDetails on Pet {
  __typename
  behaviorMetrics {
    __typename
    barking {
      count
      duration
      lastDetected
    }
    licking {
      count
      duration
      lastDetected  
    }
    scratching {
      count
      duration
      lastDetected
    }
    eating {
      count
      duration
      lastDetected
    }
    drinking {
      count  
      duration
      lastDetected
    }
  }
}

fragment EnhancedDeviceDetails on Device {
  __typename
  signalQuality {
    strength
    type
  }
  gpsAccuracy
  firmwareVersion
  hardwareVersion
}

2. Update Query Methods

• Add new query methods in query.py to fetch behavior data
• Update existing queries to include new fragments

3. Update Pet Model

Add new properties to FiPet class:

• barking_count, barking_duration, barking_last_detected
• licking_count, licking_duration, licking_last_detected
• scratching_count, scratching_duration, scratching_last_detected
• eating_count, eating_duration, eating_last_detected
• drinking_count, drinking_duration, drinking_last_detected

4. Update Device Model

Add new properties to FiDevice class:

• signal_strength
• signal_type
• gps_accuracy
• firmware_version
• hardware_version

Testing Requirements

• Test with actual Series 3+ collar to verify API responses
• Ensure backward compatibility with older collar versions
• Handle cases where behavior data is not available

Related Work

• This will also need to be implemented in hass-tryfi after pytryfi is updated
• Home Assistant sensors will need to be added for each new metric

[adamjacobmuller]

Update: Actual API Investigation Results

After deploying a test version and logging the actual TryFi API responses, here's what we discovered:

Actually Available New Fields

The Series 3+ collar provides the following new fields in the info object:

1. Battery Voltage (batteryVoltage) - Raw battery voltage in millivolts
2. Temperature (temperature) - Internal temperature (needs unit investigation - appears to be raw ADC value)
3. Uptime (uptime) - Device uptime in seconds
4. Hardware Revision (hardwareRevision) - Available at root level, returns "prod1" for Series 3+

Fields That Do NOT Exist

Despite marketing materials, the following features are not exposed via the API:

• ❌ Behavior tracking (barking, licking, scratching, eating, drinking)
• ❌ Firmware version (only buildId is available)
• ❌ GPS accuracy metrics
• ❌ Enhanced signal strength (only available for cellular connections)

Other Available Fields (Not Currently Used)

The API also returns these fields that might be useful:

• wifiNetworkNames - List of WiFi networks
• capabilityFlags - Device capabilities
• deviceStats - Various device statistics
• selfTestResults - Self-test information
• max77658Info - Power management chip information
• batteryResistanceProfile - Battery health data

Revised Implementation Plan

1. Immediate implementation - Add support for:

   • Battery voltage sensor
   • Temperature sensor (with proper unit conversion)
   • Uptime sensor
   • Hardware revision info

2. Future investigation - The behavior tracking features may:

   • Be available through a different API endpoint
   • Require a firmware update to enable
   • Be processed server-side and not yet exposed via API

Current Status

PR #8 has been updated to implement only the actually available fields. The temperature unit needs investigation as it appears to be a raw value rather than Celsius.