{ "info": { "author": "Christian K\u00fchnel", "author_email": "christian.kuehnel@gmail.com", "bugtrack_url": null, "classifiers": [], "description": "# plantgateway\nBluetooth LE to mqtt gateway for Xiaomi Mi plant sensors. For more details see the [documentation overview](doc/overview.md).\n\n# Use case\nFor many setups the Xiaomi Mi plant sensors are too far away from your \nhome server to connect directly via Bluetooth LE. \nIn such a scenario the plantgatway will poll the data from a list of \nXiaomi Mi plant sensors via Bluetooth LE using \n[miflora](https://github.com/open-homeautomation/miflora).\nThe data is then published via mqtt to your home automation server.\n\nThe plantgateway is intended to be run on a small Linux machine (e.g. \n[Raspberry Pi](https://www.raspberrypi.org/)\nor a [C.H.I.P](https://getchip.com/)) that has both Bluetooth LE and WiFi.\n\n# installation & update\n* install [python 3.4](https://www.python.org/) (or above)\nand [pip](https://pip.pypa.io/en/stable/installing/)\n```\nsudo apt-get install python3-pip build-essential libglib2.0-dev libyaml-dev\n```\n* install the plant gateway from pypi:\n```\nsudo pip install --upgrade plantgateway\n```\nor if you have multiple python and pip installations:\n```\nsudo pip3 install --upgrade plantgateway\n```\n* To update your installation just run pip again. \n\nIf you have problems with the PyYaml installation, update your pip version \nwith `sudo pip3 install --upgrade pip` and try again.\n\n# configuration\nCopy the [plantgw.yaml](plantgw.yaml) (in this repository) to your home directory and\nrename it to \".plantgw.yaml\".\nThen change this file to match your requirements.\n\n# execution\nAfter the installation with pip you can simply run the tool from the command line:\n```\nplantgateway\n```\nThere are no command line parameters and there is no interaction required.\nYou probably want to add the script to your cron tab to be executed \nin regular intervals (e.q. every hour).\n\n# integration in home automation\n\n## HomeAssistant\nIf you enable the [MQTT discovery](https://www.home-assistant.io/docs/mqtt/discovery/) \nfeature by setting the `discovery_prefix` parameter in\nthe config file, all configured sensors are automatically available in HomeAssistant.\nTo monitor the state of your plants, you can use the \n[\"plant\" component](https://www.home-assistant.io/components/plant/).\n\n\n## fhem\nTo check your plants in the home automation tool [fhem](http://fhem.de/), \nyou can use the \n[gardener](https://github.com/ChristianKuehnel/fhem-gardener) module. \nThe installation is explained on the github page of the module.\n\nIf you haven't done so, you need to configure your MQTT server in fhem with \na [MQTT](http://fhem.de/commandref.html#MQTT) module.\nFor each sensor you have, set up a [MQTT_Device](http://fhem.de/commandref.html#MQTT_DEVICE) \nand make it auto subscribe to the topic \nyou configured in the plantgateway:\n```\ndefine MQTT_Device\nattr autoSubscribeReadings //+\n```\n\nAfter that configure the gardener to match your requirements\n\n# Security\nA remark on security:\nBefore running your MQTT server on the internet make sure that you enable\nSSL/TLS encryption and client authentication.\n\n# Problem analysis\nIn case you have any problem with plantgateway, please check:\n\n- Is you configuration file a valid YAML file?\n- Does your Bluetooth dongle support Bluetooh Low Energy? Check with `sudo hcitool lescan`, this should list all Low Energy devices.\n- If you have connection issues, please try a system update `sudo apt update; sudo apt dist-upgrade`. This fixes these issues usually.\n\nIf all this does not help, please file a bug ticket in github.\n\n# License\nUnless stated otherwise all software in this repository is licensed under the Apache License 2.0\nhttp://www.apache.org/licenses/LICENSE-2.0\n\n\n", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://www.python.org/sigs/distutils-sig/", "keywords": "", "license": "", "maintainer": "", "maintainer_email": "", "name": "plantgateway", "package_url": "https://pypi.org/project/plantgateway/", "platform": "", "project_url": "https://pypi.org/project/plantgateway/", "project_urls": { "Homepage": "https://www.python.org/sigs/distutils-sig/" }, "release_url": "https://pypi.org/project/plantgateway/0.6.2/", "requires_dist": [ "bluepy (==1.3.0)", "paho-mqtt", "pyyaml (>=5.1)", "miflora (==0.5)", "typing (<4,>=3)" ], "requires_python": "", "summary": "Bluetooth to mqtt gateway for Xiaomi Mi plant sensors", "version": "0.6.2" }, "last_serial": 5526760, "releases": { "0.3.7": [ { "comment_text": "", "digests": { "md5": "e7dd6d498b0109f729960f7837bd83e1", "sha256": "0cfd3045f13cb228747e5f64a545a63454872d401a8386dc4f36748524322c16" }, "downloads": -1, "filename": "plantgateway-0.3.7.tar.gz", "has_sig": false, "md5_digest": "e7dd6d498b0109f729960f7837bd83e1", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4127, "upload_time": "2017-10-21T16:44:43", "url": "https://files.pythonhosted.org/packages/5d/1e/eca296997bb3f2dd09e29e3891d576d461556b026d2983e1937c82a3acd7/plantgateway-0.3.7.tar.gz" } ], "0.3.8": [ { "comment_text": "", "digests": { "md5": "2641d4ab29d3d78cc255fd87a7cb2335", "sha256": "633585dbde3d56d2b8716a612101c00d2568c11515a1876193f8574d5f878e32" }, "downloads": -1, "filename": "plantgateway-0.3.8.tar.gz", "has_sig": false, "md5_digest": "2641d4ab29d3d78cc255fd87a7cb2335", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4189, "upload_time": "2017-11-13T21:32:40", "url": "https://files.pythonhosted.org/packages/26/10/35db9729fc24c3974243470acc4601192c57dd23e39a42d71a2cdb53fc81/plantgateway-0.3.8.tar.gz" } ], "0.4.0": [ { "comment_text": "", "digests": { "md5": "1101d2ec63f40e19fbce99332429df8b", "sha256": "d06d359a95e235b31f51be936586d7ff49960fb74834475ac690de4d523c73bd" }, "downloads": -1, "filename": "plantgateway-0.4.0.tar.gz", "has_sig": false, "md5_digest": "1101d2ec63f40e19fbce99332429df8b", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4269, "upload_time": "2017-11-27T09:12:01", "url": "https://files.pythonhosted.org/packages/fb/d0/f7d7b140286f11030596e9d0e579db92fbc474bc4e5d006f6e1bfdc013cf/plantgateway-0.4.0.tar.gz" } ], "0.4.1": [ { "comment_text": "", "digests": { "md5": "6af3f13d133688340b650df15a8c826f", "sha256": "aeb3170ede24f2bc00fad7880a77a0377aa36ff3040d5adbe069e31d632736fb" }, "downloads": -1, "filename": "plantgateway-0.4.1.tar.gz", "has_sig": false, "md5_digest": "6af3f13d133688340b650df15a8c826f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4411, "upload_time": "2017-12-16T14:52:06", "url": "https://files.pythonhosted.org/packages/29/e8/7a4ccc7bc713b9a4765abd58ae7b99b39e25905d7440d1851e07a295096a/plantgateway-0.4.1.tar.gz" } ], "0.4.2": [ { "comment_text": "", "digests": { "md5": "4b89cdaba07c9bec2e7724ca67eace44", "sha256": "426afd05c2138e4731d2048dccee6b415d77bb4d63187b16b347fc103b831f43" }, "downloads": -1, "filename": "plantgateway-0.4.2.tar.gz", "has_sig": false, "md5_digest": "4b89cdaba07c9bec2e7724ca67eace44", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4411, "upload_time": "2017-12-16T15:00:23", "url": "https://files.pythonhosted.org/packages/01/54/647b9824f4b033ba209739192b10482494d344342e7f4b79aaf4505fa227/plantgateway-0.4.2.tar.gz" } ], "0.5.1": [ { "comment_text": "", "digests": { "md5": "a48912e2a7b6a070990e432338b5b881", "sha256": "7a94ed4858c6c6ea44792afa48400c2890cbf485aa4146efe4c77accb7fcac30" }, "downloads": -1, "filename": "plantgateway-0.5.1.tar.gz", "has_sig": false, "md5_digest": "a48912e2a7b6a070990e432338b5b881", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4937, "upload_time": "2019-01-05T13:33:57", "url": "https://files.pythonhosted.org/packages/1a/f4/dc1839cd9e807a50d5e916aac23e7e7aa285951459d43be1daf6ac0cd0c5/plantgateway-0.5.1.tar.gz" } ], "0.6.0": [ { "comment_text": "", "digests": { "md5": "b1964aaeb86f0f8ab608e610610b6f33", "sha256": "722d5ea7a6dadf163fd9aadf312c9844ad7d3a560e4025cfb59a03407826983b" }, "downloads": -1, "filename": "plantgateway-0.6.0.tar.gz", "has_sig": false, "md5_digest": "b1964aaeb86f0f8ab608e610610b6f33", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5930, "upload_time": "2019-07-13T10:27:38", "url": "https://files.pythonhosted.org/packages/c9/da/ccd9d4fc20b9ea70e93244722c931dafb2c5cd970ef37e22389858724c44/plantgateway-0.6.0.tar.gz" } ], "0.6.2": [ { "comment_text": "", "digests": { "md5": "9f9ea36d34a389de5792e20c92a03e30", "sha256": "6313881b7fc2733470ecbe3cd4c473c9690cb4a8185aa69b2f4a587e0df027f2" }, "downloads": -1, "filename": "plantgateway-0.6.2-py3-none-any.whl", "has_sig": false, "md5_digest": "9f9ea36d34a389de5792e20c92a03e30", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 11308, "upload_time": "2019-07-13T12:15:04", "url": "https://files.pythonhosted.org/packages/e8/9f/bcb52bdb092cbe8528e1de04912d91c836969cee7cce0e383f4020e2a0fb/plantgateway-0.6.2-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "dc2c1dec5ae2f1d531e91c75daed718c", "sha256": "94afd7c668cd97132305af010ad39a309dda76c4f4a033643ee589ff77b03bc3" }, "downloads": -1, "filename": "plantgateway-0.6.2.tar.gz", "has_sig": false, "md5_digest": "dc2c1dec5ae2f1d531e91c75daed718c", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6591, "upload_time": "2019-07-13T12:15:06", "url": "https://files.pythonhosted.org/packages/43/47/17ded24c50288417b7ee0b542ba9e42f6b3135128d8b451dd0aae9f95f20/plantgateway-0.6.2.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "9f9ea36d34a389de5792e20c92a03e30", "sha256": "6313881b7fc2733470ecbe3cd4c473c9690cb4a8185aa69b2f4a587e0df027f2" }, "downloads": -1, "filename": "plantgateway-0.6.2-py3-none-any.whl", "has_sig": false, "md5_digest": "9f9ea36d34a389de5792e20c92a03e30", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 11308, "upload_time": "2019-07-13T12:15:04", "url": "https://files.pythonhosted.org/packages/e8/9f/bcb52bdb092cbe8528e1de04912d91c836969cee7cce0e383f4020e2a0fb/plantgateway-0.6.2-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "dc2c1dec5ae2f1d531e91c75daed718c", "sha256": "94afd7c668cd97132305af010ad39a309dda76c4f4a033643ee589ff77b03bc3" }, "downloads": -1, "filename": "plantgateway-0.6.2.tar.gz", "has_sig": false, "md5_digest": "dc2c1dec5ae2f1d531e91c75daed718c", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6591, "upload_time": "2019-07-13T12:15:06", "url": "https://files.pythonhosted.org/packages/43/47/17ded24c50288417b7ee0b542ba9e42f6b3135128d8b451dd0aae9f95f20/plantgateway-0.6.2.tar.gz" } ] }