/ha-cyclepay

Home Assistant Integration for ESD/Hercules CyclePay Laundry Rooms

Primary LanguagePythonMIT LicenseMIT

CyclePay for Home Assistant

Home Assistant Integration for ESD / Hercules CyclePay Laundry Rooms

This is an unofficial project that is not affiliated with ESD or Hercules.


GitHub

Availability

This integration can be used by anyone who lives in an apartment building and uses one of the below apps to pay for laundry cycles:

Logo Name Links
esd cyclepay logo ESD CyclePay [iOS] [Android]
hercules cyclepay logo Hercules CyclePay [iOS] [Android]

This integration has only been tested with a facility managed by Hercules, an outsource laundry company serving the NYC metropolican area. Please open a GitHub issue to report compatibility issues with other providers.

Intro

CyclePay for Home Assistant is a Home Assistant integration that uses ESD's CyclePay / LaundryLink system to display information about the washers and dryers in your building's laundry room in Home Assistant.

Use this integration to:

  1. Avoid disappointment: Know whether any machines are available now or will be available in the next hour.
  2. Pay Easily: CyclePay is slow and requires a ridiculous number of taps to start and top off your cycle. This integration provides a faster way to add money to machines.

Warnings

  1. This integration can spend your money. Theoretically, a bug in this code could drain your entire laundry card or otherwise spend more than you intended.
  2. This integration is not endorsed or supported by ESD, Hercules, or their business partners. Use of this integration may have negative consequences, including but not limited to being banned from CyclePay.

Use this integration at your own risk.

Features

CyclePay Laundry Card Balance

Shows balance on your virtual laundry card.

Sensors for Individual Machines

Shows status of individual washers and dryers.

  1. Time remaining sensor
  2. Machine running sensor (hidden by default)
  3. Single virtual swipe button. Swipes your virtual card once in any machine.
  4. Multiple virtual swipes button. Automatically swipes your card multiple times to add time to your dryer cycle. Number of swipes is configurable via integration options.

Sensors for All Machines (by Type)

Show how many washers and dryers are available now, in 15 min, 30 min, 45 min, and 60 min. Future availability based on time remaining on currently-running machines.

Installation

Install via HACS.

Python Library

This integration communicates with CyclePay via: