[](LICENSE.md)
[]()
[]()
[](https://pypi.python.org/pypi/lnxlink/)
[]()
# 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": null,
"docs_url": null,
"requires_python": ">=3.7.0",
"maintainer_email": null,
"keywords": "lnxlink",
"author": null,
"author_email": "bkbilly <bkbilly@hotmail.com>",
"download_url": "https://files.pythonhosted.org/packages/9c/04/6e112673d1bb328eb10aee6d16f08ee747b55e4b8653e29e79542b8466d6/lnxlink-2024.11.0.tar.gz",
"platform": null,
"description": "[](LICENSE.md)\n[]()\n[]()\n[](https://pypi.python.org/pypi/lnxlink/)\n[]()\n\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\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": null,
"summary": "Internet Of Things (IOT) integration with Linux using MQTT",
"version": "2024.11.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": "5a1262b4e1281111ab83cb4c958ed0e1e64fce9d17650463f35aef22d60335eb",
"md5": "40da687d5064d83a5754df17c7db096e",
"sha256": "15078ed350c0ca14fe5611ae7eafae820aedc8a70c293651cb74438c1411c4e0"
},
"downloads": -1,
"filename": "lnxlink-2024.11.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "40da687d5064d83a5754df17c7db096e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7.0",
"size": 71766,
"upload_time": "2024-11-04T19:02:56",
"upload_time_iso_8601": "2024-11-04T19:02:56.459231Z",
"url": "https://files.pythonhosted.org/packages/5a/12/62b4e1281111ab83cb4c958ed0e1e64fce9d17650463f35aef22d60335eb/lnxlink-2024.11.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9c046e112673d1bb328eb10aee6d16f08ee747b55e4b8653e29e79542b8466d6",
"md5": "3a43d3adbc3fd7ffe3b91fa9975d850f",
"sha256": "7a1c0a9552749008f777b66aef0fb2934a4feb25541078211b930e8a13284073"
},
"downloads": -1,
"filename": "lnxlink-2024.11.0.tar.gz",
"has_sig": false,
"md5_digest": "3a43d3adbc3fd7ffe3b91fa9975d850f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7.0",
"size": 47143,
"upload_time": "2024-11-04T19:02:57",
"upload_time_iso_8601": "2024-11-04T19:02:57.864802Z",
"url": "https://files.pythonhosted.org/packages/9c/04/6e112673d1bb328eb10aee6d16f08ee747b55e4b8653e29e79542b8466d6/lnxlink-2024.11.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-04 19:02:57",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "bkbilly",
"github_project": "lnxlink",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "lnxlink"
}
JSON
