npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

homebridge-ecobee-status

v2.1.3

Published

Homebridge plugin to control Ecobee thermostat Home/Away/Sleep status through HomeKit security system interface

Downloads

388

Readme

Homebridge Ecobee Status Control

npm

This Homebridge plugin provides an elegant way to control your Ecobee thermostat's climate status (Home/Away/Sleep) through HomeKit's security system interface. Perfect for creating automations based on your daily routines or other triggers.

Features

  • Control your Ecobee's status through HomeKit's security system interface
  • Three state options:
    • Home (Stay Armed) - Resumes your regular program
    • Away (Away Armed) - Sets thermostat to Away mode
    • Sleep (Night Armed) - Sets thermostat to Sleep mode
  • Real-time status updates every 30 minutes
  • Optional automation-friendly switch for simpler Home/Away control
  • Support for single or multiple thermostats
  • Automatic token refresh handling
  • Error recovery with automatic retries

Installation

  1. Install Homebridge (if not already installed)
  2. Install this plugin:
npm i -g homebridge-ecobee-status

Configuration

Add the EcobeeStatus platform in your homebridge config.json file:

{
  "platforms": [
    {
      "name": "Ecobee Status",
      "platform": "EcobeeStatus",
      "refreshToken": "token generated with ecobee-auth-cli",
      "thermostatSerialNumbers": "100904852660,654234216036",
      "enableAutomationSwitch": false
    }
  ]
}

Configuration Options

| Option | Required | Description | |--------|----------|-------------| | name | No | The name that will appear in your Home app | | platform | Yes | Must be "EcobeeStatus" | | refreshToken | Yes | Authentication token (see below) | | thermostatSerialNumbers | No | Comma-separated list of thermostats to control | | enableAutomationSwitch | No | Adds a simple ON/OFF switch for Away control (default: false) |

Getting a Refresh Token

  1. Install the plugin globally:
npm i -g homebridge-ecobee-status
  1. Run the authentication CLI:
ecobee-auth-cli
  1. Follow the prompts to:

    • Log in to your Ecobee web portal
    • Navigate to the "My Apps" tab
    • Enter the provided PIN
    • Authorize the application
  2. Copy the generated refresh token into your config file

The plugin will automatically handle token refreshes and update the config file as needed.

Thermostat Serial Numbers (Optional)

If you have multiple thermostats, you can specify which ones to control by adding their serial numbers. Find these in your Ecobee app or website under each thermostat's "About" page.

Leave this field blank to control all registered thermostats.

Automation Switch (Optional)

Enable enableAutomationSwitch to add a simple ON/OFF switch that controls Home/Away status. This can be useful for:

  • HomeKit automations that don't support security system triggers
  • Simple Home/Away control without the security system interface
  • Third-party integrations

The switch states correspond to:

  • ON = Away
  • OFF = Home

Usage

After installation and configuration:

  1. Open the Home app
  2. Find the new security system control
  3. Use the states as follows:
    • Stay Armed = Home mode
    • Away Armed = Away mode
    • Night Armed = Sleep mode

The status will automatically sync between HomeKit and your Ecobee every 30 minutes.

Troubleshooting

  • Authentication Issues: Run ecobee-auth-cli again to generate a new token
  • State Sync Issues: Check your Homebridge logs for any API errors
  • Multiple Thermostats: Verify serial numbers are correct in config
  • Status Not Updating: Ensure auto home/away is disabled in Ecobee settings

Support

License

This project is licensed under the Apache License, Version 2.0 - see the LICENSE file for details.

Credits