{ "info": { "author": "Ivan Mironov", "author_email": "mironov.ivan@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Environment :: Console", "Intended Audience :: Developers", "Intended Audience :: End Users/Desktop", "License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)", "Operating System :: POSIX :: Linux", "Programming Language :: Python :: 2", "Programming Language :: Python :: 2.7" ], "description": "# cometblue\n## What is it?\n\"Comet Blue\" is \"The intelligent Bluetooth enabled energy-saving radiator thermostat\", as stated in official documentation. Link to manufacturer's web page: http://www.eurotronic.org/produkte/comet-blue.html.\n\nFrom the software point of view, \"Comet Blue\" is an BLE (Bluetooth Low Energy) device that implements GATT (Generic Attribute Profile Specification).\n\nThis project provides python library and command line tool which may be used to control \"Comet Blue\" from any linux system equipped with Bluetooth adapter (USB Bluetooth dongle, for example).\n\n## Installation\nFrom sources:\n```\n# Install dependencies\npip install -r requirements.txt\n# Install cometblue\npython setup.py install\n```\nUsing *pip*:\n```\npip install cometblue\n```\n\n## Command line tool\n### Generic options\n```\nUsage: cometblue [OPTIONS] COMMAND [ARGS]...\n\n Command line tool for \"Comet Blue\" radiator thermostat\n\nOptions:\n -a, --adapter TEXT Bluetooth adapter interface [default: hci0]\n -f, --formatter [json|human-readable|shell-var]\n Output formatter [default: human-readable]\n -L, --log-level TEXT [default: error]\n -h, --help Show this message and exit.\n```\n\n### Device discovery\n```\nUsage: cometblue discover [OPTIONS]\n\n Discover \"Comet Blue\" Bluetooth LE devices\n\nOptions:\n -t, --timeout INTEGER Device discovery timeout in seconds [default: 10]\n -h, --help Show this message and exit.\n```\n*cometblue* automatically filters device list and shows only supported devices.\n\nUsage example:\n```\n# cometblue discover\nComet Blue (E0:E5:CF:D6:98:53)\n```\n\n### Device functions\n```\nUsage: cometblue device [OPTIONS] ADDRESS COMMAND [ARGS]...\n\n Get or set values\n\nOptions:\n -p, --pin TEXT PIN for connecting to device (factory default PIN is 0)\n -P, --pin-file TEXT Read PIN for connecting to device from file\n -h, --help Show this message and exit.\n\nCommands:\n backup Backup all supported configuration values in...\n get Get value\n restore Restore configuration values from backup in...\n set Set value (always requires PIN)\n```\n\n#### Get values\n```\nUsage: cometblue device get [OPTIONS] COMMAND [ARGS]...\n\n Get value\n\nOptions:\n -h, --help Show this message and exit.\n\nCommands:\n battery Get battery charge (requires PIN)\n datetime Get time and date (requires PIN)\n days Get configured periods per days of the week...\n device_name Get device name\n firmware_revision Get firmware revision\n firmware_revision2 Get firmware revision #2 (requires PIN)\n flags Get flags (requires PIN)\n holidays Get configured holidays (requires PIN)\n lcd_timer Get LCD timer (requires PIN)\n manufacturer_name Get manufacturer name\n model_number Get model number\n software_revision Get software revision\n temperatures Get temperatures (requires PIN)\n```\nUsage examples:\n```\n# cometblue device -p 0 E0:E5:CF:D6:98:53 get battery\n39%\n\n# cometblue device -p 0 E0:E5:CF:D6:98:53 get datetime\n2016-03-27 18:32:00\n\n# cometblue device -p 0 E0:E5:CF:D6:98:53 get temperatures\nCurrent temperature: 23.0 \u00b0C\nTemperature for manual mode: 16.0 \u00b0C\nTarget temperature low: 16.0 \u00b0C\nTarget temperature high: 21.0 \u00b0C\nOffset temperature: 0.0 \u00b0C\nWindow open detection: 4\nWindow open minutes: 10\n\n# cometblue device E0:E5:CF:D6:98:53 get device_name # no PIN required\nComet Blue\n\n# cometblue device E0:E5:CF:D6:98:53 get firmware_revision # no PIN required\nCOBL0126\n\n# cometblue device E0:E5:CF:D6:98:53 get software_revision # no PIN required\n0.0.6-sygonix1\n```\n\n#### Set values\n```\nUsage: cometblue device set [OPTIONS] COMMAND [ARGS]...\n\n Set value (always requires PIN)\n\nOptions:\n -h, --help Show this message and exit.\n\nCommands:\n datetime Set time and date (requires PIN)\n day Set periods per days of the week (requires...\n holiday Set period and temperature for holiday...\n lcd_timer Set LCD timer (requires PIN)\n pin Set PIN (requires PIN)\n temperatures Set temperatures (requires PIN)\n```\nUsage examples:\n```\n# cometblue device -p 0 E0:E5:CF:D6:98:53 set datetime # set time and date on device to current time and date\n\n# cometblue device -p 0 E0:E5:CF:D6:98:53 set datetime \"2014-08-27 12:23:56\" # set time and date on device to some specific value\n\n# cometblue device -p 0 E0:E5:CF:D6:98:53 set pin 123 # change PIN from factory default (\"0\") to new one (\"123\")\n```\n\n##### Changing per day time periods\n```\nUsage: cometblue device set day [OPTIONS] DAY [PERIOD]...\n\n Set periods per days of the week (requires PIN)\n\nOptions:\n -h, --help Show this message and exit.\n```\n\nUsage examples:\n```\n# cometblue device -p 0 E0:E5:CF:D6:98:53 set day wed # clear settings for Wednsday\n\n# cometblue device -p 0 E0:E5:CF:D6:98:53 set day sun -- \"-04:00:00\" \"07:30:00-14:50:00\" \"21:00:00-\" # set three periods for Sunday\n```\nDay may be specified as a full weekday name, short weekday name or number (*\"monday\"* == *\"mon\"* == *\"1\"*). Up to four periods may be specified per day. Each period should be in one of following formats:\n - *\"-MM:HH:SS\"* - from the beginning of day (*00:00:00*) to *MM:HH:SS*.\n - *\"mm:hh:ss-MM:HH:SS\"*\n - *\"mm:hh:ss-\"* - from *mm:hh:ss* to the the end of day (23:59:59).\n\n##### Changing holidays\n```\nUsage: cometblue device set holiday [OPTIONS] HOLIDAY [START] [END]\n [TEMPERATURE]\n\n Set period and temperature for holiday (requires PIN)\n\nOptions:\n -h, --help Show this message and exit.\n```\nUsage example:\n```\n# cometblue device -p 0 E0:E5:CF:D6:98:53 set holiday 4 \"2015-12-31 00:00:00\" \"2016-01-14 18:00:00\" 23.5 # define holiday 4\n\n# cometblue device -p 0 E0:E5:CF:D6:98:53 set holiday 4 # clear settings for holiday 4\n```\nUp to eight holidays supported.\n\n#### Backup and restore\n```\nUsage: cometblue device backup [OPTIONS] [FILE_NAME]\n\n Backup all supported configuration values in JSON format to file or stdout\n\nOptions:\n -h, --help Show this message and exit.\n\nUsage: cometblue device restore [OPTIONS] [FILE_NAME]\n\n Restore configuration values from backup in JSON format (from file or\n stdin)\n\nOptions:\n -h, --help Show this message and exit.\n```\nUsage example:\n```\n# cometblue device -p 0 E0:E5:CF:D6:98:53 backup ./backup.json # backup current settings\n\n# cometblue device -p 0 E0:E5:CF:D6:98:53 restore ./backup.json # restore settings from backup\n```\n\n## Links\n- http://torsten-traenkner.de/wissen/smarthome/heizung.php\n\n## TODO\n- Support flags\n- Support timer\n- Write tests\n- Python3\n\n## Notes\nTool and library may not work as expected because it is not well tested. Patches and bugreports are always welcome.", "description_content_type": null, "docs_url": null, "download_url": "UNKNOWN", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/im-0/cometblue", "keywords": "cometblue bluetooth ble gatt", "license": "UNKNOWN", "maintainer": null, "maintainer_email": null, "name": "cometblue", "package_url": "https://pypi.org/project/cometblue/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/cometblue/", "project_urls": { "Download": "UNKNOWN", "Homepage": "https://github.com/im-0/cometblue" }, "release_url": "https://pypi.org/project/cometblue/0.1.2/", "requires_dist": null, "requires_python": null, "summary": "Command line tool and python library for \"Comet Blue\" radiator thermostat", "version": "0.1.2" }, "last_serial": 2029867, "releases": { "0.1.2": [ { "comment_text": "", "digests": { "md5": "b24c565b09164f5c3da4fb781935ed3f", "sha256": "af2ef8b1619d406ff6a4e6f9c494e36b319578d9574a679868456e36fb5472b2" }, "downloads": -1, "filename": "cometblue-0.1.2.tar.gz", "has_sig": false, "md5_digest": "b24c565b09164f5c3da4fb781935ed3f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 26869, "upload_time": "2016-03-27T14:40:45", "url": "https://files.pythonhosted.org/packages/11/73/8fb02d016792fea2b3b10045bb8415784fed408eed7b286b4dc7ab8dc17f/cometblue-0.1.2.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "b24c565b09164f5c3da4fb781935ed3f", "sha256": "af2ef8b1619d406ff6a4e6f9c494e36b319578d9574a679868456e36fb5472b2" }, "downloads": -1, "filename": "cometblue-0.1.2.tar.gz", "has_sig": false, "md5_digest": "b24c565b09164f5c3da4fb781935ed3f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 26869, "upload_time": "2016-03-27T14:40:45", "url": "https://files.pythonhosted.org/packages/11/73/8fb02d016792fea2b3b10045bb8415784fed408eed7b286b4dc7ab8dc17f/cometblue-0.1.2.tar.gz" } ] }