Skip to content

Home

Jump to bottom
Scott Gusler edited this page Feb 13, 2026 · 16 revisions

Clockwork icon

Clockwork Integration Documentation

Welcome to the Clockwork integration for Home Assistant! This comprehensive guide will walk you through all the features and calculations available.

Table of Contents

  1. Timespan Calculation
  2. Offset Calculation
  3. Datetime Offset
  4. Date Range Duration
  5. Season Detection
  6. Month Detection
  7. Holiday Countdown
  8. Between Dates Check
  9. Outside Dates Check
  10. Custom Holidays

Getting Started

Installation

  1. Install Clockwork via HACS
  2. Go to Settings > Devices & Services > Create Automation
  3. Choose "Clockwork" from the list
  4. Follow the UI to add your first calculation

Configuration

Each calculation type has its own configuration options available through the UI. No YAML editing is required!

User Interface

Clockwork provides an intuitive interface for managing all your calculations:

Main Menu

The main configuration menu shows all available options:

Clockwork Main Menu

Modifying Calculations

Select existing calculations to edit their settings:

Modify Calculation Selection

Deleting Calculations

Remove calculations you no longer need:

Delete Calculation Selection

What Sensors Does Clockwork Create?

Clockwork creates different types of sensors depending on the calculation:

  • Numeric Sensors: Timespan, Date Range Duration, Holiday Countdown
  • Binary Sensors: Offset, Season, Month, Between Dates, Outside Dates
  • Timestamp Sensors: Datetime Offset

Example Sensors

Key Features

  • No YAML Required: All configuration through user-friendly UI
  • Dynamic Updates: Real-time updates for time-based calculations
  • Flexible Triggering: Control which state changes trigger offset calculations
  • Custom Holidays: Define your own holidays for countdown calculations
  • Timezone Aware: Automatic timezone handling for datetime comparisons

Common Use Cases

  • Automation Delays: Use offset calculations to trigger automations after a delay
  • Time-Based Automation: Use timespan to measure how long something has been in a state
  • Business Hours: Use between dates to check if current time is within business hours
  • Seasonal Logic: Use season detection for seasonal automations
  • Countdown: Use holiday countdown to create countdown automations

Next: Get started with Timespan Calculation →

Clone this wiki locally