lnxlink


Namelnxlink JSON
Version 2024.3.0 PyPI version JSON
download
home_pagehttps://bkbilly.github.io/lnxlink
SummaryInternet Of Things (IOT) integration with Linux using MQTT
upload_time2024-02-29 09:17:58
maintainer
docs_urlNone
author
requires_python>=3.7.0
license
keywords lnxlink
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            [![license](https://img.shields.io/badge/license-MIT-blue)](LICENSE.md)
[![OS - Linux](https://img.shields.io/badge/OS-Linux-blue?logo=linux&logoColor=white)]()
[![Python 3.7](https://img.shields.io/badge/Python-3.7-blue?logo=python&logoColor=white)]()
[![PyPI](https://img.shields.io/pypi/v/lnxlink?logo=pypi&logoColor=white)](https://pypi.python.org/pypi/lnxlink/)
[![Last commit](https://img.shields.io/github/last-commit/bkbilly/lnxlink?color=blue&logo=github&logoColor=white)]()

<img align="right" width="170" height="100" src="https://github.com/bkbilly/lnxlink/blob/master/logo.png?raw=true">

# LNXlink
LNXlink is a Linux companion app that seamlessly integrates your system with external applications like Home Assistant.
It uses MQTT, a lightweight messaging protocol, to enable real-time data exchange and remote control capabilities.

With LNXlink, you can monitor your Linux machine's performance, execute commands remotely, and integrate it into your smart home ecosystem for centralized management.

# Key Features
 - **Sensor Monitoring:** Automatically or manually expose sensors that monitor and control the system remotely.
 - **Home Assistant:** Utilizes MQTT Autodiscovery to create entities in Home Assistant dashboard.
 - **Easy Installation:** No sudo privileges required for installation and operation, except for server environments.
 - **Expandable Architecture:** Automatically imports new modules and allows for the addition of custom modules.

# Get started
To get started with LNXlink, follow these simple steps:
 - Download the LNXlink application and install it on your Linux machine: `pipx install lnxlink`
 - Follow the configuration instructions to setup LNXlink: `lnxlink -c lnxlink.yaml`
 - Install and configure on Home Assistant the [hass-mqtt-mediaplayer](https://github.com/bkbilly/hass-mqtt-mediaplayer) integration.
 - Enjoy real-time monitoring and control of your Linux machine from your Home Assistant dashboard.

For detailed installation instructions, please refer to the documentation page: [bkbilly.gitbook.io/lnxlink](https://bkbilly.gitbook.io/lnxlink).

# Benefits
 - **Cross-Platform Compatibility:** Runs on any Linux distribution, providing flexibility and wide-ranging compatibility.
 - **Enhanced System Insights:** Gain real-time insights into your Linux machine's performance by monitoring essential system metrics.
 - **Remote Command Execution:** Execute arbitrary commands directly from your Home Assistant dashboard, granting remote control over your Linux machine.
 - **Seamless Integration with Home Assistant:** Integrate your Linux machine into your smart home ecosystem for unified control and monitoring.
 - **Automate tasks:** Set up automated tasks to perform repetitive actions and save yourself time and effort.


# Support LNXlink's Development
To contribute to the development of LNXlink, you can sponsor the project through [GitHub Sponsors](https://github.com/sponsors/bkbilly) or [PayPal](https://www.paypal.com/paypalme/bkbillybk). Your support will help maintain the project, add new features, and fix bugs.

            

Raw data

            {
    "_id": null,
    "home_page": "https://bkbilly.github.io/lnxlink",
    "name": "lnxlink",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.7.0",
    "maintainer_email": "",
    "keywords": "lnxlink",
    "author": "",
    "author_email": "bkbilly <bkbilly@hotmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/42/af/df3024cf5e7279b95ba790e3d29e21d7e3d21d88b7292dc865f5a4e6f602/lnxlink-2024.3.0.tar.gz",
    "platform": null,
    "description": "[![license](https://img.shields.io/badge/license-MIT-blue)](LICENSE.md)\n[![OS - Linux](https://img.shields.io/badge/OS-Linux-blue?logo=linux&logoColor=white)]()\n[![Python 3.7](https://img.shields.io/badge/Python-3.7-blue?logo=python&logoColor=white)]()\n[![PyPI](https://img.shields.io/pypi/v/lnxlink?logo=pypi&logoColor=white)](https://pypi.python.org/pypi/lnxlink/)\n[![Last commit](https://img.shields.io/github/last-commit/bkbilly/lnxlink?color=blue&logo=github&logoColor=white)]()\n\n<img align=\"right\" width=\"170\" height=\"100\" src=\"https://github.com/bkbilly/lnxlink/blob/master/logo.png?raw=true\">\n\n# LNXlink\nLNXlink is a Linux companion app that seamlessly integrates your system with external applications like Home Assistant.\nIt uses MQTT, a lightweight messaging protocol, to enable real-time data exchange and remote control capabilities.\n\nWith LNXlink, you can monitor your Linux machine's performance, execute commands remotely, and integrate it into your smart home ecosystem for centralized management.\n\n# Key Features\n - **Sensor Monitoring:** Automatically or manually expose sensors that monitor and control the system remotely.\n - **Home Assistant:** Utilizes MQTT Autodiscovery to create entities in Home Assistant dashboard.\n - **Easy Installation:** No sudo privileges required for installation and operation, except for server environments.\n - **Expandable Architecture:** Automatically imports new modules and allows for the addition of custom modules.\n\n# Get started\nTo get started with LNXlink, follow these simple steps:\n - Download the LNXlink application and install it on your Linux machine: `pipx install lnxlink`\n - Follow the configuration instructions to setup LNXlink: `lnxlink -c lnxlink.yaml`\n - Install and configure on Home Assistant the [hass-mqtt-mediaplayer](https://github.com/bkbilly/hass-mqtt-mediaplayer) integration.\n - Enjoy real-time monitoring and control of your Linux machine from your Home Assistant dashboard.\n\nFor detailed installation instructions, please refer to the documentation page: [bkbilly.gitbook.io/lnxlink](https://bkbilly.gitbook.io/lnxlink).\n\n# Benefits\n - **Cross-Platform Compatibility:** Runs on any Linux distribution, providing flexibility and wide-ranging compatibility.\n - **Enhanced System Insights:** Gain real-time insights into your Linux machine's performance by monitoring essential system metrics.\n - **Remote Command Execution:** Execute arbitrary commands directly from your Home Assistant dashboard, granting remote control over your Linux machine.\n - **Seamless Integration with Home Assistant:** Integrate your Linux machine into your smart home ecosystem for unified control and monitoring.\n - **Automate tasks:** Set up automated tasks to perform repetitive actions and save yourself time and effort.\n\n\n# Support LNXlink's Development\nTo contribute to the development of LNXlink, you can sponsor the project through [GitHub Sponsors](https://github.com/sponsors/bkbilly) or [PayPal](https://www.paypal.com/paypalme/bkbillybk). Your support will help maintain the project, add new features, and fix bugs.\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "Internet Of Things (IOT) integration with Linux using MQTT",
    "version": "2024.3.0",
    "project_urls": {
        "Documentation": "https://bkbilly.gitbook.io/lnxlink",
        "Homepage": "https://bkbilly.github.io/lnxlink",
        "Source Code": "https://github.com/bkbilly/lnxlink"
    },
    "split_keywords": [
        "lnxlink"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "1ed626d033b65cebb2eba773c7b2389d05687c26c354dd81d3949556d1fc67df",
                "md5": "4cf51b0587debde7375fad88ff81efe4",
                "sha256": "0a96f23a652f5ec55b714eef9fdb9af8a7cf16adfad041213ac31f0d7e1d401b"
            },
            "downloads": -1,
            "filename": "lnxlink-2024.3.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "4cf51b0587debde7375fad88ff81efe4",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7.0",
            "size": 50391,
            "upload_time": "2024-02-29T09:17:56",
            "upload_time_iso_8601": "2024-02-29T09:17:56.869445Z",
            "url": "https://files.pythonhosted.org/packages/1e/d6/26d033b65cebb2eba773c7b2389d05687c26c354dd81d3949556d1fc67df/lnxlink-2024.3.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "42afdf3024cf5e7279b95ba790e3d29e21d7e3d21d88b7292dc865f5a4e6f602",
                "md5": "e3dd01ff190e7aeb7fb9e6040aef23df",
                "sha256": "c7c60d6632e5124d332f5cf3d060d3313a798ecf1eb5ffc7892c40396dd773cd"
            },
            "downloads": -1,
            "filename": "lnxlink-2024.3.0.tar.gz",
            "has_sig": false,
            "md5_digest": "e3dd01ff190e7aeb7fb9e6040aef23df",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7.0",
            "size": 32723,
            "upload_time": "2024-02-29T09:17:58",
            "upload_time_iso_8601": "2024-02-29T09:17:58.794465Z",
            "url": "https://files.pythonhosted.org/packages/42/af/df3024cf5e7279b95ba790e3d29e21d7e3d21d88b7292dc865f5a4e6f602/lnxlink-2024.3.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-02-29 09:17:58",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "bkbilly",
    "github_project": "lnxlink",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "lnxlink"
}
        
Elapsed time: 0.19940s