{ "info": { "author": "Emmanuel Levijarvi", "author_email": "emansl@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Intended Audience :: Developers", "License :: OSI Approved :: BSD License", "Operating System :: OS Independent", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3", "Topic :: Home Automation", "Topic :: Utilities" ], "description": "Meter Reader\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\n.. image:: https://api.codacy.com/project/badge/Grade/06a4909b69f947c4a70b9938ff0fc942\n :alt: Codacy Badge\n :target: https://www.codacy.com/app/emansl/meter_reader?utm_source=github.com&utm_medium=referral&utm_content=eman/meter_reader&utm_campaign=badger\nRelease 1.1.2\n\nMeter Reader is a client library and command line client for retrieving\nnearly realtime energy usage data from a smart meter via the Eagle\u2122 Home\nEnergy Gateway. See\n`Rainforest\u2122 Automation `_ for more\nabout the Eagle\u2122 Home Energy Gateway.\n\nMeter Reader is not affiliated with the Eagle\u2122 Home Energy Gateway or\nRainforest\u2122 Automation.\n\nInstallation\n-------------------------------------------------------------------------------\n\n.. code-block:: bash\n\n $ pip install meter-reader\n\nUsage\n-------------------------------------------------------------------------------\nMeter Reader is intended to be used as a library for other applications\nbut it does contain a command line application called mr.\n\n.. code-block:: bash\n\n $ mr < ip address >\n\nThis will run the ``list_devices`` devices command on the gateway and display\na formatted response. Other commands, such as ``get_device_data``, will first\nrun the ``list_devices`` command to determine the MAC address of the gateway.\n\nCommands can be specified with the `'-c'` option. For example\n\n.. code-block:: bash\n\n $ mr -c get_device_data < ip address >\n\n MessageCluster\n DeviceMacId xx:xx:xx:xx:xx:xx:xx:xx\n MeterMacId xx:xx:xx:xx:xx:xx:xx\n TimeStamp 0\n Id 0\n Priority None\n Text None\n ConfirmationRequired N\n Confirmed N\n Read Y\n Queue active\n CurrentSummation\n DeviceMacId xx:xx:xx:xx:xx:xx:xx:xx\n MeterMacId xx:xx:xx:xx:xx:xx:xx\n TimeStamp 2014-04-19 16:01:22+00:00\n SummationDelivered 12949746\n SummationReceived 0\n Multiplier 1\n Divisor 1000\n DigitsRight 3\n DigitsLeft 15\n SuppressLeadingZero Y\n NetworkInfo\n ...\n\n $ mr -c get_summation_values < ip address >\n\n 2014-04-18 16:30:00+00:00, Summation, 0.350\n 2014-04-18 17:30:00+00:00, Summation, 0.322\n 2014-04-18 18:30:00+00:00, Summation, 0.193\n 2014-04-18 19:30:00+00:00, Summation, 0.285\n 2014-04-18 20:30:00+00:00, Summation, 0.286\n 2014-04-18 21:30:00+00:00, Summation, 0.351\n ...\n\nThere are two ways to retrieve instantaneous demand:\n\n1. Send the ``get_instantaneous_demand`` command directly to the gateway. This\n will return a nearly raw response from the gateway (formatting is applied).\n\n.. code-block:: bash\n\n $ mr -c get_instantaneous_demand < ip address >\n\n InstantaneousDemand\n DeviceMacId xx:xx:xx:xx:xx:xx:xx:xx\n MeterMacId xx:xx:xx:xx:xx:xx:xx\n TimeStamp 2014-04-19 15:35:27+00:00\n Demand 297\n Multiplier 1\n Divisor 1000\n DigitsRight 3\n DigitsLeft 15\n SuppressLeadingZero Y\n\n2. Supply the ``--get-instant-demand`` argument. This will post-process the\nresponse before displaying it.\n\n.. code-block:: bash\n\n $ mr --get-instant-demand < ip address >\n\n 2014-04-19 15:58:39+00:00, 0.292kW\n\nRaw and unformatted data returned by the gatway, can be viewed by using the\n`'-r'` option.\n\n.. code-block:: bash\n\n $ mr -r -c get_device_data < ip address >\n\nIncluding Meter Reader in an application\n-------------------------------------------------------------------------------\n\n.. code-block:: python\n\n from meter_reader import Gateway\n\n GATEWAY_ADDRESS = '192.168.1.10'\n\n gw = Gateway(GATEWAY_ADDRESS)\n response = gw.run_command('get_device_data')\n print('Network Info')\n print(response['NetworkInfo'])\n\n timestamp, demand = gw.get_instantaneous_demand()\n print('Demand {0!s} at {1!s}'.format(demand, timestamp))\n\n\nLicense\n===============================================================================\nCopyright \u00a9 2017, Emmanuel Levijarvi\nAll rights reserved.\n\nRedistribution and use in source and binary forms, with or without\nmodification, are permitted provided that the following conditions are met:\n\n* Redistributions of source code must retain the above copyright notice, this\n list of conditions and the following disclaimer.\n\n* Redistributions in binary form must reproduce the above copyright notice,\n this list of conditions and the following disclaimer in the documentation\n and/or other materials provided with the distribution.\n\nTHIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\"\nAND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE\nIMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE\nDISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE\nFOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL\nDAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR\nSERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER\nCAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,\nOR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE\nOF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n\nNotice\n===============================================================================\nEagle\u2122 is a trademark of Rainforest\u2122 Automation\n", "description_content_type": null, "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/eman/meter_reader", "keywords": "energy electricity smartmeter HAN", "license": "BSD", "maintainer": "", "maintainer_email": "", "name": "meter-reader", "package_url": "https://pypi.org/project/meter-reader/", "platform": "", "project_url": "https://pypi.org/project/meter-reader/", "project_urls": { "Homepage": "https://github.com/eman/meter_reader" }, "release_url": "https://pypi.org/project/meter-reader/1.1.2/", "requires_dist": null, "requires_python": "", "summary": "Client Library for retreiving smart meter data from an Eagle Energy Gateway", "version": "1.1.2" }, "last_serial": 2982685, "releases": { "1.0.0": [ { "comment_text": "", "digests": { "md5": "d66c31df6043aea3c356e9edcdfc0486", "sha256": "ce46af1f69679511811ed4f94ab264c9c074bf3ce4f5d2f7c54a751428bce3b5" }, "downloads": -1, "filename": "meter_reader-1.0.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "d66c31df6043aea3c356e9edcdfc0486", "packagetype": "bdist_wheel", "python_version": "3.4", "requires_python": null, "size": 10151, "upload_time": "2014-04-23T04:06:28", "url": "https://files.pythonhosted.org/packages/56/e8/6b5fe14366943f1c5498951f11921b9c3bed5cd45544d7d05028ab8a5f29/meter_reader-1.0.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "2a0830d9b08dd71bbcba626f8a0f156b", "sha256": "435d7e5bfe21517248ce94727ef2dd04a34adb10b43f4898718c95e98b6e6555" }, "downloads": -1, "filename": "meter-reader-1.0.0.tar.gz", "has_sig": false, "md5_digest": "2a0830d9b08dd71bbcba626f8a0f156b", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6669, "upload_time": "2014-04-23T04:06:11", "url": "https://files.pythonhosted.org/packages/92/cf/879b7307cffe752e13eb259d621a77c3b7424e66e155c243ff5a3274fc56/meter-reader-1.0.0.tar.gz" } ], "1.0.1": [ { "comment_text": "", "digests": { "md5": "de70cad180bfeed99788e1f6d49f8e72", "sha256": "19046a8334b4406e3d53341d607de50515e334ef570808892a8b218c702c33bf" }, "downloads": -1, "filename": "meter_reader-1.0.1-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "de70cad180bfeed99788e1f6d49f8e72", "packagetype": "bdist_wheel", "python_version": "3.4", "requires_python": null, "size": 10131, "upload_time": "2014-04-23T05:29:52", "url": "https://files.pythonhosted.org/packages/85/22/796d3b5afc30b0da573446db57e56ea2337d219ef72d90c2538e2777b062/meter_reader-1.0.1-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "6879c43affff251fc311a8f56a694bfb", "sha256": "9e6171a28da13e2ceccb0cb13789ef2ca5605ddf246af1bed0848fe77a3fe60a" }, "downloads": -1, "filename": "meter-reader-1.0.1.tar.gz", "has_sig": false, "md5_digest": "6879c43affff251fc311a8f56a694bfb", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6669, "upload_time": "2014-04-23T05:29:43", "url": "https://files.pythonhosted.org/packages/74/b0/995462020a2127361943a29000b6539e3a64c45b3a8df043b62dde741e72/meter-reader-1.0.1.tar.gz" } ], "1.0.2": [ { "comment_text": "", "digests": { "md5": "96dba3d3131ea23209406390d467d912", "sha256": "e9e5a30b7f42d549b84ed2699b9e4fe51b02cc8330e4f2b3fbcd5a28583f5dc2" }, "downloads": -1, "filename": "meter_reader-1.0.2-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "96dba3d3131ea23209406390d467d912", "packagetype": "bdist_wheel", "python_version": "2.7", "requires_python": null, "size": 10316, "upload_time": "2014-07-13T05:00:14", "url": "https://files.pythonhosted.org/packages/ae/b0/b75c83a376900896c9f6f8a7388a4158fd96e178336df2818eb6f62f7497/meter_reader-1.0.2-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "c565b0a4601e879cdecd7eef84448c5a", "sha256": "ef5aba1f6f5fff31e2044aeb6d9f98d4c8526c06c91bd9f1c7db99358dc36b16" }, "downloads": -1, "filename": "meter-reader-1.0.2.tar.gz", "has_sig": false, "md5_digest": "c565b0a4601e879cdecd7eef84448c5a", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6770, "upload_time": "2014-07-13T05:00:26", "url": "https://files.pythonhosted.org/packages/1c/29/9fc16c385674c567e7b6d2da86ea0cefa56b239c5a70fc0fca55139f1609/meter-reader-1.0.2.tar.gz" } ], "1.1.0": [ { "comment_text": "", "digests": { "md5": "cbefccdb0873946a6aea2a8d819c5335", "sha256": "afa85fa4e5250150c6da58abb369cb97aebddf11c832f87268a6d2a0f6df385d" }, "downloads": -1, "filename": "meter_reader-1.1.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "cbefccdb0873946a6aea2a8d819c5335", "packagetype": "bdist_wheel", "python_version": "3.5", "requires_python": null, "size": 10474, "upload_time": "2016-07-11T06:32:05", "url": "https://files.pythonhosted.org/packages/87/3a/8337bb310095e0c439493c479c2f71abc0a1572c9efb014c827ee6e55b81/meter_reader-1.1.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "5a406b9ff598e94bef44d5f813bd8d3e", "sha256": "be51fd4949b32d20779ce2be110ed180ff6a63660385c56ff911d01175a5db43" }, "downloads": -1, "filename": "meter-reader-1.1.0.tar.gz", "has_sig": false, "md5_digest": "5a406b9ff598e94bef44d5f813bd8d3e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6764, "upload_time": "2016-07-11T06:30:49", "url": "https://files.pythonhosted.org/packages/30/b9/041d082bf27bc8ab0bfff689308b7f75f493bc9e6f51ca950744f014ae46/meter-reader-1.1.0.tar.gz" } ], "1.1.1": [ { "comment_text": "", "digests": { "md5": "8872fe5bc9fa12c69e76c00d86fd42d3", "sha256": "e7f69435b985be9dc6282670cb2cdd10025c47e98b975b22975aa908ee0237c1" }, "downloads": -1, "filename": "meter_reader-1.1.1-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "8872fe5bc9fa12c69e76c00d86fd42d3", "packagetype": "bdist_wheel", "python_version": "3.6", "requires_python": null, "size": 10604, "upload_time": "2017-06-27T00:12:52", "url": "https://files.pythonhosted.org/packages/21/f5/659cc607f3f8558073ad7cc93170c1b2731239d4814a5f5da2310734f4ad/meter_reader-1.1.1-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "357cf7c290e5d590d79e407a35215cae", "sha256": "726063372b4cd45745f3ae947c4dc1f1f8372ea7a0532c5122f7a8335811aa44" }, "downloads": -1, "filename": "meter-reader-1.1.1.tar.gz", "has_sig": false, "md5_digest": "357cf7c290e5d590d79e407a35215cae", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6957, "upload_time": "2017-06-27T00:13:21", "url": "https://files.pythonhosted.org/packages/d7/03/8c3a6f4bfd0966156dd3f383c52b98398a844b6fb10d51e1d34102935669/meter-reader-1.1.1.tar.gz" } ], "1.1.2": [ { "comment_text": "", "digests": { "md5": "f2f5b0455f7891ac0d68f8d03d2192f8", "sha256": "000272ccd7dc8fd58bf2f4573d9771515a244c959582858f466012ab1e6ed10b" }, "downloads": -1, "filename": "meter_reader-1.1.2-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "f2f5b0455f7891ac0d68f8d03d2192f8", "packagetype": "bdist_wheel", "python_version": "3.6", "requires_python": null, "size": 10612, "upload_time": "2017-06-27T17:47:34", "url": "https://files.pythonhosted.org/packages/74/fa/d91f129f94d4945a41fa776f2fa3453859bbd3f23ac3ec31f9ecf62f906f/meter_reader-1.1.2-py2.py3-none-any.whl" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "f2f5b0455f7891ac0d68f8d03d2192f8", "sha256": "000272ccd7dc8fd58bf2f4573d9771515a244c959582858f466012ab1e6ed10b" }, "downloads": -1, "filename": "meter_reader-1.1.2-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "f2f5b0455f7891ac0d68f8d03d2192f8", "packagetype": "bdist_wheel", "python_version": "3.6", "requires_python": null, "size": 10612, "upload_time": "2017-06-27T17:47:34", "url": "https://files.pythonhosted.org/packages/74/fa/d91f129f94d4945a41fa776f2fa3453859bbd3f23ac3ec31f9ecf62f906f/meter_reader-1.1.2-py2.py3-none-any.whl" } ] }