Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/diyhue/diyHue

Main diyHue software repo
https://github.com/diyhue/diyHue

Last synced: 14 days ago
JSON representation

Main diyHue software repo

Awesome Lists containing this project

README

        

# diyHue - A Hue Bridge Emulator
[![Discourse](https://img.shields.io/discourse/users?server=https%3A%2F%2Fdiyhue.discourse.group)](https://diyhue.discourse.group) [![JoinSlack](https://img.shields.io/badge/Join%20us-on%20Slack-green.svg)](https://diyhue.slack.com/) [![Build Status](https://github.com/diyhue/diyHue/workflows/diyHue%20CI%20Build/badge.svg)](https://github.com/diyhue/diyHue/actions)



![diyHueLogo](https://diyhue.org/cdn/img/diyHue-Logo.png)


diyHue provides a Ecosystem for several Smart Home Solutions, eliminating the need for vendor specific Bridges and Hardware.
Written in Python and Open Source, you are now able to import and control all your Lights and Sensors into one System.

Lightweight and resource friendly, to run on small devices like the RPi .... 24/7

The Best part? No Cloud connection by Design!

Enjoy your diyHue enlighted Home.

![diyHue ecosystem](https://raw.githubusercontent.com/diyhue/diyhue.github.io/master/assets/images/hue-map.png)

## Stats
[![DockerPulls](https://img.shields.io/docker/pulls/diyhue/core.svg)](https://hub.docker.com/r/diyhue/core/)
[![CommitActivity](https://img.shields.io/github/commit-activity/y/diyhue/diyhue.svg)](https://github.com/diyhue/diyHue/commits/master)
[![arm version badge](https://images.microbadger.com/badges/version/diyhue/core:arm.svg)](https://microbadger.com/images/diyhue/core:arm "Get your own version badge on microbadger.com")
[![arm-size-batch](https://images.microbadger.com/badges/image/diyhue/core:arm.svg)](https://microbadger.com/images/diyhue/core:arm "Get your own image badge on microbadger.com")
[![amd version badge](https://images.microbadger.com/badges/version/diyhue/core:amd64.svg)](https://microbadger.com/images/diyhue/core:amd64 "Get your own version badge on microbadger.com")
[![amd size badge](https://images.microbadger.com/badges/image/diyhue/core:amd64.svg)](https://microbadger.com/images/diyhue/core:amd64 "Get your own image badge on microbadger.com")

## Getting Started

All documentation and instructions can be found over at [diyhue.readthedocs.io](https://diyhue.readthedocs.io/)

## Requirements

- coap-client: i.e. via `apt install libcoap2-bin`
- Python 3
- Python modules: ws4py, requests, astral, paho-mqtt [see requirements.txt](./requirements.txt)
- faketime: i.e. via `apt install faketime`

or

- Docker

## Recommendation - minimal setup
You need a System that can run the python script or Docker Image 24/7!

Emulator | Lights | App
-------- | -------- | ---
RaspberryPi 3B | WS2812 Strip + Wemos D1 mini Board | [Hue Essentials (iOS & Android)](https://hueessentials.com)

## Working diyHue features
Functions | Devices | Apps | Lights | Smarthome
--------- | ------- | ---- | ------ | ---------
Control lights (all functions) | Amazon Alexa (control only the lights) | [Hue Essentials](https://hueessentials.com) | WS2812B and SK6812 smart led strips| [Home Assistant](https://homeassistant.io) |
Control groups (all functions) | Deconz (Conbee 1 & 2) | Hue App| Phillips Hue | [Openhab](https://openhab.org)
Scenes (all functions) | Trådfri Gateway | hueManic | Ikea Trådfri| Jeedom
Routines | Hue Bridge (original + other emulators) | Kodi Hue Ambilight| Yeelight | Domoticz
Wake up | Logitech Harmony| OnSwitch| MiLight | [Home Assistant Add-on](https://github.com/MaxBec/hassio-diyHue)
Go to sleep |Philips Ambilight TV's | LampShade| [Hyperion.ng](https://github.com/hyperion-project/hyperion.ng) |
Switches (custom esp8266 switches) | | Hue Sync for PC| MQTT lights [see mqtt](https://diyhue.readthedocs.io/en/latest/lights/mqtt.html) |
Autodiscover lights | | HueSwitcher | any PWM(CCT, RGB, RGBW) incl. Dimming|
Hue entertainment | | | On/Off 433Mhz devices (multiple devices for every esp8266) |
| || | LYT8266|
| || | [WLED](https://github.com/aircoookie/wled)|

## Support

All documentation and instructions can be found over at [diyhue.readthedocs.io](https://diyhue.readthedocs.io/)

If you need help with diyHue you can get support from other users, aswell as the maintainer.

Please use GitHub, Slack or Discourse, other platforms are not checked by the maintainers.

### Slack [![JoinSlack](https://img.shields.io/badge/Join%20us-on%20Slack-green.svg)](https://diyhue.slack.com/) [![SlackStatus](https://slackinvite.squishedmooo.com/badge.svg?colorB=8ebc06)](https://slackinvite.squishedmooo.com/)
Use Slack for a general chat or fast live support.

However: Since Slack is faster at providing live Support but not as good when it comes to save and show known Issues, we kindly ask you to open a Topic at our Discourse group. This will provide Help for others in the future.

### Discourse [![Discourse](https://img.shields.io/discourse/users?server=https%3A%2F%2Fdiyhue.discourse.group)](https://diyhue.discourse.group)

Our Board might already have your fix and answer ready. Have a look!

> General Note:
> Please provide some Logs to make it easier for all of us. Enable Debug by manually starting diyHue with additional `--debug true` argument.

## Stability

Starting in Dec. 2020 we will introduce one Master and one Dev Branch. The Master will have the most stable code.

If you want to tinker and experiment you can try the dev Branch. Active development will take place here.

You want to get the latest features? Try the experimental Branch. Use at own Risk!


Please post on our [Slack team](https://slackinvite.squishedmooo.com/) any other device/application that you find to work with this emulator.

## Contribute

diyHue is Opensource and maintained by volunteers in their free time. You are welcome to contribute and become a recognised member of the diyHue community.
Feel free to add PR and Commits to our Dev Branch.
If you are experienced in
- Webdesign
- Python
- Arduino
- Coding in general

We highly appreciate your support, making diyHue even better!

## Support

diyHue is and will be Free to use. However it does take a lot of time to maintain the code etc etc.

Long story short.... you can support us at Ko-Fi

[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/R6R54Y1LF)

Thank you very much!

## Credits

- Ben ([@cheesemarathon](https://github.com/cheesemarathon)) All fancy github integrations
- [Stephan van Rooij](https://github.com/svrooij) - zigbee2mqtt integration
- [@avinashraja98](https://github.com/avinashraja98) - Hue Entertainment server
- Federico Zivolo ([@FezVrasta](https://github.com/FezVrasta)) Internal WebGUI
- [@J3n50m4t](https://github.com/J3n50m4t) - Yeelight integration
- Martin Černý ([@mcer12](https://github.com/mcer12)) - Yeelight color bulb
- probonopd https://github.com/probonopd/ESP8266HueEmulator
- sidoh https://github.com/sidoh/esp8266_milight_hub
- StefanBruens https://github.com/StefanBruens/ESP8266_new_pwm
- Cédric @ticed35 for linkbutton implementation
- [@cheesemarathon](https://github.com/cheesemarathon) - Help with Docker images
- [@Mevel](https://github.com/Mevel) - 433Mhz devices
- [@Nikfinn99](https://github.com/Nikfinn99) - PCB designs
- [@crankyoldgit](https://github.com/crankyoldgit) - IR Remote library

## Additional Projects and Ideas

Hue living color light project for 3D printing: [Thingiverse 2773413](https://www.thingiverse.com/thing:2773413)

## License

[![license](https://img.shields.io/badge/license-GPLv3%2FApache%202.0%2FCC%20BY--SA%204.0-blue.svg)](https://github.com/diyhue/diyHue/blob/master/LICENSE.md)