BSD 2-Clause "Simplified" License

项目介绍

aluminiumgeek/goodbye-mihome 是一个托管在 GitHub 上的开源项目,主要使用 Python 编写,采用 BSD 2-Clause "Simplified" License 许可证,目前获得 100 个 Star、12 次 Fork。

仓库全名
aluminiumgeek/goodbye-mihome
开源许可证
BSD 2-Clause "Simplified" License
Star 数
100
Fork 数
12
未关闭 Issue
1

README 摘要

Goodbye MiHome Break into API of smart home products from Xiaomi and wrap sensors data to cozy web interface. If you like this project, you might want to buy me a cup of coffee :) Currently supported devices Temperature and humidity sensor: collect data, show current value and line charts. Magnet (door/window close sensor): collect data, show current status, pubsub service to be used in apps. Gateway LED: change…

完整内容见 GitHub 原始 README 或本页 。

常见问题

goodbye-mihome 用什么语言开发?

主要使用 Python 编写,采用 BSD 2-Clause "Simplified" License 许可证,目前有 100 个 Star。

goodbye-mihome 可以免费商用吗?

仓库采用 BSD 2-Clause "Simplified" License 许可证,可免费使用与修改,商业使用请遵守许可证条款(例如保留版权声明与许可声明)。

如何获取 goodbye-mihome 的源码?

可以直接克隆仓库:git clone https://github.com/aluminiumgeek/goodbye-mihome.git,默认分支为 master;安装与运行步骤见仓库 README。

goodbye-mihome 最近还在维护吗?

仓库最近一次更新为 2023年5月26日,当前有 1 个未关闭 Issue;Star 数为 100,可作为社区活跃度的参考。

关于

Web UI and plugins to manage Xiaomi MiHome gateway, sensors and smart devices.

描述取自 GitHub 官方 API,中文内容由 GitRead 中文社区 编辑团队整理。

简要分析

热度分
141
价值分
65
活跃状态
活跃

语言占比

CSS
HTML
JavaScript
Python

README

Goodbye MiHome

Break into API of smart home products from Xiaomi and wrap sensors data to cozy web interface.

If you like this project, you might want to buy me a cup of coffee :)

Currently supported devices

  • Temperature and humidity sensor: collect data, show current value and line charts.
  • Magnet (door/window close sensor): collect data, show current status, pubsub service to be used in apps.
  • Gateway LED: change color, set brightness, toggle status, show current value.
  • Gateway Speaker: play standard and user-defined (uploaded via MiHome app) sounds with custom volume, interrupt playing.
  • Yeelight smart LED bulbs: toggle status, set brightness, set name, create scenes, manage cron jobs.

The list will expand as I receive more Xiaomi devices and make plugins for them. Feel free to write your plugins if you have other devices/sensors.

Setup and running

  1. Ensure you have Python 3, PostgreSQL, Redis installed.
  2. Clone the repo
  3. Create a PostgreSQL database and import init.sql
  4. Install required python packages: pip install -r requirements.txt
  5. Copy config.py.example to config.py and fill it with your settings
  6. Run python mihome.py to start data collector, web application and load apps defined in ENABLED_APPS.
    Additionally, run python mihome.py shell to start interactive intepreter (useful to test commands).

Apps

Besides displaying sensors and devices data and change settings from the web interface, you could write some useful apps using Goodbye-MiHome. For example, you could parse your electricity supplier’s website and start red LED blinking on the gateway when there’s a news about upcoming power outage in your area.

Some sample apps could be found in apps directory.

You could enable or disable an app by changing ENABLED_APPS section in config.py

Background images for web interface

To make web interface even better, you could put your favorite images into web/static/img/bg/ directory. Background image changes every 5 minutes (hovewer, you could tweak the interval in js file).

goodbye-mihome

评论

暂无评论