# homeThing

**Repository Path**: dongbaohua/homeThing

## Basic Information

- **Project Name**: homeThing
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: GPL-3.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-04-30
- **Last Updated**: 2025-04-30

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README


<h1 align = "center">homeThing Remote ⚙️</h1>
<h5 align = "center">(esphome remote)</h1>
<p align="center">
<a href="https://github.com/landonr/esphome-remote/stargazers"><img src="https://img.shields.io/github/stars/landonr/esphome-remote?style=for-the-badge"/></a>
<a href="https://discord.gg/BX6ZtGKHTy"><img src="https://img.shields.io/discord/1021434469917413498?style=for-the-badge"/></a>
</p>

#### homeThing is a collection of software and hardware for creating universal remotes that control smart home devices.
There are 3 components that belong to homeThing: the case and circuit board, the menu system code, and the code to control smart home devices
- <a href="#hardware-">Hardware specific for smart home remotes that's open source, customizable, and 3D printable.</a>
- <a href="#homething-menu-">Menu system for ESP32 devices focused on controlling smart home devices similar to an iPod's menu.</a>
- [ESPHome Components for controlling Home Assistant devices.](https://github.com/landonr/esphome-components)

<br>
<div align="center">
	<h2><a href="https://homething.io/Buy">Buy now on homeThing.io! Over 20 sold!</a></h2>
</div>
<br>

### Learn More
 - [Get Started](GettingStarted.md) - Learn how to build your own remote
 - [Discord](https://discord.gg/BX6ZtGKHTy) - support / chat with the community and the team
 - [Instagram](https://www.instagram.com/homething.io/) - Follow us on Instagram for updates and new products
 - [Website](https://homething.io) - Check out our website for more information

<div align="center">
	<h3>
	<a href="https://youtu.be/5bx5w-n5c0Y">
		<img src="https://img.youtube.com/vi/5bx5w-n5c0Y/0.jpg" alt="Demo Video" />
		<br>Demo Video - Watch on YouTube 🎬
	</a>
	</h3>
</div>

# Hardware 💪
We designed the two remotes below to be ideal for controlling smart home devices without a touch screen. They are both battery-powered but can also be plugged into USB and left in one place. The first remote was based on a Lilygo TDisplay. We moved on to building the homeThing S3 because the original device had slow performance, lacked buttons, and had challenges with assembly.
<table>
  <tr>
    <th>
	    <h3>TDisplay homeThing</h3>
    </th>
    <th>
	    <h3>TDisplay S3 homeThing</h3>
	    <a href="https://github.com/landonr/homeThing/tree/main/Case%20Design/tdisplay-s3">More Info</a><br>
    </th>
  </tr>
  <tr>
    <td><img src="https://github.com/landonr/homeThing/assets/2607659/4054f110-6d8d-4764-8aab-d7287209cb47" width="400"/></td>
    <td><img src="https://github.com/landonr/homeThing/assets/2607659/b19a5b39-b0dd-4bac-9803-df9a452ab56b" width="400"/></td>

  </tr>
  <tr>
	  <td>Not available for purchase</td>
	  <td><a href="https://homething.io/Buy">Buy fully assembled, ships within 3 business days from 🇨🇦</a></td>
  </tr>
  <tr>
    <td><a href="https://www.pcbway.com/project/shareproject/homeThing_V1_3_e3572f8f.html">Order Case from PCBWay</a></td>
    <td>
      <a href="https://www.pcbway.com/project/shareproject/homeThing_S3_2b3ac3ac.html">Order parts or fully assembled from PCBWay</a>
    </td>
  </tr>
  <tr>
    <td><a href="https://github.com/landonr/homeThing/tree/main/Case%20Design">Case 3D Files</a></td>
    <td><a href="https://github.com/landonr/homeThing/tree/main/Case%20Design">Case 3D Files</a></td>
  </tr>
  <tr>
    <td><a href="tdisplay-ipod.yaml">ESPHome Config</a></td>
    <td><a href="tdisplay-s3.yaml">ESPHome Config</a></td>
  </tr>
  <tr>
  	<td>
	<h4>Features</h4>
	<ul>
		<li>Based on Lilygo TTGo TDisplay, an ESP32 with integrated screen
		<li>Low cost remote with minimal parts</li>
		<li>Scroll wheel and 2 configurable buttons</li>
		<li>USB-C Charging</li>
		<li>3D Printable case with 3 parts</li>
	</ul>
	</td>
  	<td>
	<h4>Features</h4>
	<ul>
		<li>Based on Lilygo TDisplay S3, an ESP32 S3 with integrated screen</li>
		<li>Faster processor and larger display</li>
		<li>Custom PCB for easier setup</li>
		<li>IR Blaster for controlling infrared devices</li>
		<li>Interal microphone for Voice Assistant</li>
		<li>Scroll wheel and 5 configurable buttons</li>
		<li>USB-C Charging</li>
		<li>3D Printable case with 2 parts</li>
	</ul>
	</td>
  </tr>
</table>

We made a couple of custom devices for running homeThing, but it can also run on almost any ESP32 such as,
- M5Stack Fire
- M5Stick C
- Lilygo T-Display T4
- Lilygo T-Display TTGO
- Lilygo T-Display S3
# homeThing Menu 📝
### ESPHome menu system that requires minimal config. Features apps which have custom UIs
|t-display demo|m5stack fire demo|lilygo T4 demo|
|--|--|--|
|![Scroll Demo Gif](docs/scrollListSelectTDisplay.gif)|![Scroll List Fire Demo Gif](docs/m5stackFireDemo.gif)|![Lilygo T4 Demo](docs/t4Demo.gif)

- Scroll through list and press center to select
- With a scrollwheel the top button goes back
- On M5Stack going up past the top of the list will go back
- A scroll bar appears if list extends past the screen. 
- Screen returns to now playing after display sleeps
    - Display sleeps after 10s of idle. Device sleeps after 2h of idle 💤
- Font size and UI size is adjustable in yaml 🔨
- Simple yaml configuration. all of the complicated code is included in other files 🛠
- Header is always shown at the top with info about the current state

## Apps
### Now playing screen ⏯
<img src="docs/nowPlayingOverlay.png"/>
<ul>
<li>Control media players using the scroll wheel buttons</li>
<li>Scroll for volume using the scroll wheel</li>
</ul>

|Music|TV|
|--|--|
|<ul><li>Control smart speakers like Sonos, Spotify, or Google Home</li><li>Change source from Spotify playlists, Sonos Favorites, and custom lists</li><li>Manage speaker groups</li></ul>|<ul><li>Menu navigation such as up, down, left, right, select (with scroll wheel)</li><li>Power, back, home, pause in second menu</li><li>Change source from tv source list</li><li>Optional soundbar support</li></ul>|

### IR Remote
<ul>
<li>Custom UI and buttons to control infrared cat toys</li>
</ul>

### Games
<ul>
<li>Snake</li>
<li>Breakout</li>
</ul>


# Mentions
- Home Assistant Voice Contest - Best Starting Guide https://www.home-assistant.io/blog/2024/03/16/voice-assistant-community-contest-winners-annoucement/
- Hackaday https://hackaday.com/2022/09/08/scroll-through-esphome-with-ipod-style-click-wheel/
- Hackster https://www.hackster.io/news/ipod-style-esphome-remote-3ca38edab2b4
- Reddit post https://www.reddit.com/r/homeassistant/comments/x59dcp/i_built_an_ipod_style_esphome_remote_for_home/
- Self Hosted - Episode 80 - Solving Whole Home Audio (around 30:00) https://selfhosted.show/80 

# Includes
- <a href="https://esphome.io/">ESPHome</a>
- <a href="https://github.com/be5invis/Iosevka">Iosevka Font</a>
- [@ssieb](https://github.com/ssieb)'s <a href="https://github.com/ssieb/custom_components/tree/master/components/ip5306">IP5306 esphome component</a>
- <a href="https://github.com/landonr/esphome-components">homeThing ESPHome Components</a>

# Sponsorship

<img src="https://freight.cargo.site/w/800/i/a931690205c27162476213b8bcc171585aad9d84d65cdc121ca425e813114121/0x0.png" data-caption="PCBWay Logo" data-no-zoom="">

## [PCBWay](https://pcbway.com/g/Xymq6O "PCBWay") sponsors 3D Printing and PCB assembly costs on this project during the prototyping phase! 
If you are interested in their awesome fabrication services please check them out.&nbsp; They offer 

3D prototyping,&nbsp;PCB design and assembly, as well as CNC metal fabrication.&nbsp; Costs are reasonable and the quality is as good as it gets.&nbsp; Thank you PCBWay for sponsoring us and other fun projects!<br><br>

## [cargo](https://cargo.site/ "cargo.site") sponsors our website!

They make it super easy to keep things pretty and up to date! It’s honestly so much easier than managing our own site, highly recommended!