Skip to content

TimCinel/ha-screentimenetwork

Repository files navigation

The Screentime Network Integration for Home Assistant

GitHub Release GitHub Activity License hacs

This integration provides a sensor for your screen time sourced from thescreentimenetwork.com.

image image

Installation

HACS (Recommended)

  1. Ensure that HACS is installed.
  2. Go to HACS → Integrations → ⋮ → Custom repositories
  3. Add repository URL: https://github.com/TimCinel/ha-screentimenetwork
  4. Category: Integration
  5. Click "Add"
  6. Search for "The Screentime Network" in HACS and install it
  7. Restart Home Assistant.

Manual Installation

  1. Download the custom_components/screentimenetwork directory from the latest release.
  2. Copy it into your custom_components directory.
  3. Restart Home Assistant.

Prerequisites

Before configuring this integration, you need:

  1. A Screentime Network account - Sign up at thescreentimenetwork.com/api/getting-started
  2. ClearSpace iOS app - Install from App Store
    • Grant Screen Time permissions
    • Log in with your Screentime Network account
    • This app collects and reports your screen time data

Configuration

  1. In the Home Assistant UI, go to Configuration > Integrations.
  2. Click the + ADD INTEGRATION button.
  3. Search for "The Screentime Network".
  4. Enter your username (handle) and API key from thescreentimenetwork.com.

Features

  • Provides a sensor showing your screen time data
  • Updates hourly from thescreentimenetwork.com
  • Screen time values are approximate and rounded to the nearest 15-minute interval (due to Apple Screen Time API constraints)

Support

For issues, please visit the issue tracker.

Contributing

Contributions are welcome! Please read our Contributing Guide for details.

License

This project is licensed under the MIT License - see the LICENSE file for details.