mywattsmon


Namemywattsmon JSON
Version 0.9.5 PyPI version JSON
download
home_pageNone
SummaryMonitoring power and energy in the smart home
upload_time2024-10-06 14:45:35
maintainerNone
docs_urlNone
authorhttps://github.com/berryunit
requires_python>=3.11
licensemywattsmon Copyright (c) 2024 - berryunit MIT License Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
keywords smart home diy power energy
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # **mywattsmon**

A minimal Python application for monitoring electrical power and energy in the smart home.

- Support for devices such as energy meters, smart plugs, etc.
- 24/7 monitor process with scheduled data storage
- Optional monitor window
- Low resource requirements
- Easily configurable via JSON file
- Extendable with your own device classes

A computer running Python version 3.11 or higher is required. For SBCs such as Raspberry Pi, a hard disk (e.g. a USB SSD) is recommended, as SD cards are generally not suitable for continuous operation.

## Installation

The application should be installed in a user directory, as it saves data and can be extended individually.

	python -m pip install mywattsmon -U -t <target directory> 

Alternatively, the release file can be downloaded from the respository and unpacked.

## Usage

In the following, it is assumed that the application has been installed on a Linux computer into the user's home directory (e.g. into /home/u1/mywattsmon) and that the calls are made from the home directory (/home/u1).

Start the monitor process (exit with Ctrl+C):

	python -m mywattsmon.app.monitor
    
Start the monitor window (exit with Ctrl+C, in the window using the exit button or escape key):

	python -m mywattsmon.app.window

*Note: When the application is started for the first time, the data directory mywattsmon-data is created parallel to the application directory. Among other things, this contains the configuration file config.json with a configuration of the device class Mock. As this class provides random numbers, the application can be executed directly after installation without further configuration.*

## Further information

- Documentation: /mywattsmon/doc/*
- Repository: https://github.com/berryunit/mywattsmon
- License: MIT

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "mywattsmon",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.11",
    "maintainer_email": null,
    "keywords": "smart home, diy, power, energy",
    "author": "https://github.com/berryunit",
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/13/97/97ad475ef20d5010e0b9c7d9665c24bf86cfb7ca74d7a7756b2bd815c330/mywattsmon-0.9.5.tar.gz",
    "platform": null,
    "description": "# **mywattsmon**\n\nA minimal Python application for monitoring electrical power and energy in the smart home.\n\n- Support for devices such as energy meters, smart plugs, etc.\n- 24/7 monitor process with scheduled data storage\n- Optional monitor window\n- Low resource requirements\n- Easily configurable via JSON file\n- Extendable with your own device classes\n\nA computer running Python version 3.11 or higher is required. For SBCs such as Raspberry Pi, a hard disk (e.g. a USB SSD) is recommended, as SD cards are generally not suitable for continuous operation.\n\n## Installation\n\nThe application should be installed in a user directory, as it saves data and can be extended individually.\n\n\tpython -m pip install mywattsmon -U -t <target directory> \n\nAlternatively, the release file can be downloaded from the respository and unpacked.\n\n## Usage\n\nIn the following, it is assumed that the application has been installed on a Linux computer into the user's home directory (e.g. into /home/u1/mywattsmon) and that the calls are made from the home directory (/home/u1).\n\nStart the monitor process (exit with Ctrl+C):\n\n\tpython -m mywattsmon.app.monitor\n    \nStart the monitor window (exit with Ctrl+C, in the window using the exit button or escape key):\n\n\tpython -m mywattsmon.app.window\n\n*Note: When the application is started for the first time, the data directory mywattsmon-data is created parallel to the application directory. Among other things, this contains the configuration file config.json with a configuration of the device class Mock. As this class provides random numbers, the application can be executed directly after installation without further configuration.*\n\n## Further information\n\n- Documentation: /mywattsmon/doc/*\n- Repository: https://github.com/berryunit/mywattsmon\n- License: MIT\n",
    "bugtrack_url": null,
    "license": "mywattsmon  Copyright (c) 2024 - berryunit  MIT License  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:  The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.  THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
    "summary": "Monitoring power and energy in the smart home",
    "version": "0.9.5",
    "project_urls": {
        "repository": "https://github.com/berryunit/mywattsmon"
    },
    "split_keywords": [
        "smart home",
        " diy",
        " power",
        " energy"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "25b04d58e5b40f6c87f5f68f38c77487c2f1a3a979104622a05a2098f4980dc7",
                "md5": "ff1228b438ab921c562cf2d297e0e051",
                "sha256": "d6d1b305d7aa184a4d80b348ef6580844900589e19dfac69cca92db4a8673b61"
            },
            "downloads": -1,
            "filename": "mywattsmon-0.9.5-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "ff1228b438ab921c562cf2d297e0e051",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.11",
            "size": 1228781,
            "upload_time": "2024-10-06T14:45:32",
            "upload_time_iso_8601": "2024-10-06T14:45:32.318179Z",
            "url": "https://files.pythonhosted.org/packages/25/b0/4d58e5b40f6c87f5f68f38c77487c2f1a3a979104622a05a2098f4980dc7/mywattsmon-0.9.5-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "139797ad475ef20d5010e0b9c7d9665c24bf86cfb7ca74d7a7756b2bd815c330",
                "md5": "5df1cba390b82a8f7f86911256c6244f",
                "sha256": "050158b4c173a4f1f676c778237c92aff0ab63a9b81495b13ee3f35fad1c8d15"
            },
            "downloads": -1,
            "filename": "mywattsmon-0.9.5.tar.gz",
            "has_sig": false,
            "md5_digest": "5df1cba390b82a8f7f86911256c6244f",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.11",
            "size": 1216713,
            "upload_time": "2024-10-06T14:45:35",
            "upload_time_iso_8601": "2024-10-06T14:45:35.000652Z",
            "url": "https://files.pythonhosted.org/packages/13/97/97ad475ef20d5010e0b9c7d9665c24bf86cfb7ca74d7a7756b2bd815c330/mywattsmon-0.9.5.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-10-06 14:45:35",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "berryunit",
    "github_project": "mywattsmon",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "mywattsmon"
}
        
Elapsed time: 0.33884s