Skip to content

Latest commit

 

History

History
73 lines (53 loc) · 4.64 KB

README.md

File metadata and controls

73 lines (53 loc) · 4.64 KB

Melacha Plug Banner

PRs Welcome Codacy Badge Donate

Melacha Plug

A Melacha aware plug which knows when it's Shabbos or Yom Tov.

This project is using ESPHome.

Looking to disable a smart doorbell for Shabbos? Worried about Google or Alexa accidentally triggering on Shabbos or Yom Tov? The solution is here!

Features

  • Smart: It features a full Jewish calendar on board, not just for Shabbos, but also for Yom Tov!
  • Failsafe: Buttons are disabled on Shabbos and Yom Tov for added security.
  • Intelligent: It automatically detects your location and provides the option to further customize.
  • Aware: A LED flash lets you know when Shabbos mode is enabled.
  • Local: All logic is processed on board.
  • Adaptable: All code is open source, allowing for easy tweaking, correction, and expansion.
  • Easy: Simply plug and play, and you're all set!

Web Server Screenshot

Getting Started

What You'll Need

  • A plug with ESPHome or Tasmota software installed.
  • Pre-flashed plugs can be bought from the Athom or Cloud Free shop. There is also some preflashed plugs to be found on Ebay, and Amazon.

Installation

Pre-configured

Limitations

  • Timezone is locked to EST unless you flash it yourself.
  • Your location won't be 100% accurate (you can update it via the web UI).

Instructions

  • Download the melachaplug.bin file from above. (currently none are compiled)
  • If your device is using Tasmota, follow instructions on how to upgrade from the ESPHome docs or Tasmota docs.
  • If your device is using ESPHome, use the web UI to install the firmware.
  • Once the firmware is installed it will create a WiFi access point called "Melacha Plug Fallback", connect to it using any phone or computer.
  • On the devices webpage enter in your WiFi details (it should pop up, if it doesn't then it can be accessed via it's IP).
  • The device will restart, and should appear on your WiFi network.

Custom Configuration

  • Set up your own ESPhome instance. If you have Home Assistant then use the ESPHome Dashboard, otherwise follow the Command Line Interface guide.
  • Find the YAML file for your device from the esphome folder above.
  • Configure the YAML settings to your liking, and flash device (more details on the ESPHome site).

Advanced

Using Relays

You can customize this project for any sort of relays, including the sonoff basic.

Shabbos Mode

Shabbos from this project can be reused to be helpful in all types of projects.

Potential Use Cases

  • Those with motion based lights, can have the motion disabled on Shabbos and Yom Tov.
  • Preserve energy usage during Shabbos and Yom Tov, for example of water heaters (temperature should be kept above °120F to prevent Legionnaires’ disease).
  • Turn off security cameras.
  • Disable accidental light switch triggers on Shabbos and Yom Tov (advanced).
  • Turn on a hot water urn before Shabbos and have it auto turn off after.
  • Disable a dishwasher so it won't accidentally get turned on.

Contribute

paypal - or - "Buy Me A Coffee"