ps2mqtt


Nameps2mqtt JSON
Version 0.0.7 PyPI version JSON
download
home_pagehttps://github.com/dgomes/ps2mqtt
SummaryPython daemon that gets information from psutil to an mqtt broker for integration with Home Assistant.
upload_time2023-09-12 22:47:09
maintainer
docs_urlNone
authorDiogo Gomes
requires_python
license
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            [![PyPI version](https://badge.fury.io/py/ps2mqtt.svg)](https://badge.fury.io/py/ps2mqtt)

# ps2mqtt
Python daemon that gets information from [psutil](https://github.com/giampaolo/psutil) to an mqtt broker for integration with [Home Assistant](https://www.home-assistant.io).

## Install

You can install ps2mqtt from pypi:
```bash
$ pip install ps2mqtt
```

If you wish to run ps2mqtt through systemd, download the ps2mqtt.service file from this repository and edit according to your system.

Then just copy to systemd path and enable the service before starting:

```bash

$ sudo cp ps2mqtt.service /etc/systemd/system/

$ sudo systemctl enable ps2mqtt.service 

$ systemctl start ps2mqtt.service 

```

## Options

ps2mqtt has several command line options you should use when customizing ps2mqtt.service:

```txt
  -h, --help                                  show this help message and exit
  --config CONFIG                             configuration file, will be created if non existing
  --period PERIOD                             updates period in seconds
  --mqtt-server MQTT_SERVER                   MQTT server
  --mqtt-port MQTT_PORT                       MQTT port
  --mqtt-username MQTT_USERNAME               MQTT username
  --mqtt-password MQTT_PASSWORD               MQTT password
  --mqtt-base-topic MQTT_BASE_TOPIC           MQTT base topic
  --ha-discover-prefix HA_DISCOVER_PREFIX     HA discover mqtt prefix
  --ha-status-topic HA_STATUS_TOPIC           HA status mqtt topic
  ```
  
You can also store all the options in a file, just run all your options plus the `--config /etc/ps2mqtt.yaml` to store all your parameters in a config file. Next time you run, just use `--config /etc/ps2mqtt.yaml`.

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/dgomes/ps2mqtt",
    "name": "ps2mqtt",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "",
    "author": "Diogo Gomes",
    "author_email": "diogogomes@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/d1/d5/c9235d170aae09de439e1011a19e221bcd765c26b49377178915681bf54f/ps2mqtt-0.0.7.tar.gz",
    "platform": null,
    "description": "[![PyPI version](https://badge.fury.io/py/ps2mqtt.svg)](https://badge.fury.io/py/ps2mqtt)\n\n# ps2mqtt\nPython daemon that gets information from [psutil](https://github.com/giampaolo/psutil) to an mqtt broker for integration with [Home Assistant](https://www.home-assistant.io).\n\n## Install\n\nYou can install ps2mqtt from pypi:\n```bash\n$ pip install ps2mqtt\n```\n\nIf you wish to run ps2mqtt through systemd, download the ps2mqtt.service file from this repository and edit according to your system.\n\nThen just copy to systemd path and enable the service before starting:\n\n```bash\n\n$ sudo cp ps2mqtt.service /etc/systemd/system/\n\n$ sudo systemctl enable ps2mqtt.service \n\n$ systemctl start ps2mqtt.service \n\n```\n\n## Options\n\nps2mqtt has several command line options you should use when customizing ps2mqtt.service:\n\n```txt\n  -h, --help                                  show this help message and exit\n  --config CONFIG                             configuration file, will be created if non existing\n  --period PERIOD                             updates period in seconds\n  --mqtt-server MQTT_SERVER                   MQTT server\n  --mqtt-port MQTT_PORT                       MQTT port\n  --mqtt-username MQTT_USERNAME               MQTT username\n  --mqtt-password MQTT_PASSWORD               MQTT password\n  --mqtt-base-topic MQTT_BASE_TOPIC           MQTT base topic\n  --ha-discover-prefix HA_DISCOVER_PREFIX     HA discover mqtt prefix\n  --ha-status-topic HA_STATUS_TOPIC           HA status mqtt topic\n  ```\n  \nYou can also store all the options in a file, just run all your options plus the `--config /etc/ps2mqtt.yaml` to store all your parameters in a config file. Next time you run, just use `--config /etc/ps2mqtt.yaml`.\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "Python daemon that gets information from psutil to an mqtt broker for integration with Home Assistant.",
    "version": "0.0.7",
    "project_urls": {
        "Homepage": "https://github.com/dgomes/ps2mqtt"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d1d5c9235d170aae09de439e1011a19e221bcd765c26b49377178915681bf54f",
                "md5": "aa260ece9ff1cd2521dcc70c6da7685a",
                "sha256": "172749cc3907a470a89a7b4124e07cf1f98b574604866eb83887e08900e6b4a1"
            },
            "downloads": -1,
            "filename": "ps2mqtt-0.0.7.tar.gz",
            "has_sig": false,
            "md5_digest": "aa260ece9ff1cd2521dcc70c6da7685a",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 6002,
            "upload_time": "2023-09-12T22:47:09",
            "upload_time_iso_8601": "2023-09-12T22:47:09.413497Z",
            "url": "https://files.pythonhosted.org/packages/d1/d5/c9235d170aae09de439e1011a19e221bcd765c26b49377178915681bf54f/ps2mqtt-0.0.7.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-09-12 22:47:09",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "dgomes",
    "github_project": "ps2mqtt",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "ps2mqtt"
}
Diogo Gomes
Elapsed time: 0.11830s