HA-EasyComputerManager/README.md

82 lines
3.6 KiB
Markdown
Raw Normal View History

2023-12-31 14:57:18 +01:00
# 🖧 Easy Computer Manager
[![hacs_badge](https://img.shields.io/badge/HACS-Custom-41BDF5.svg?style=for-the-badge)](https://github.com/hacs/integration)
[![GitHub release (latest by date)](https://img.shields.io/github/v/release/M4TH1EU/HA-EasyComputerManage?style=for-the-badge)](./releases/)
2024-06-09 11:42:28 +02:00
![img.png](.images/header.png)
2023-12-31 16:53:26 +01:00
2024-06-09 11:42:28 +02:00
Easy Computer Manager is a custom integration for Home Assistant that allows you to remotely manage various aspects of
your computer, such as sending Wake-On-LAN (WoL) packets, restarting the computer between different operating systems (
if dual-boot), adjusting audio configurations, changing monitor settings, and more.
2023-12-31 14:57:18 +01:00
## Features
- Send Wake-On-LAN (WoL) packets to wake up a device.
- Restart the computer between Windows and Linux (dual-boot systems).
- Directly start the computer into Windows.
- Put the computer into sleep mode.
- Restart the computer.
- Modify monitor configurations.
- Start/Stop Steam Big Picture mode.
- Adjust audio settings (volume, mute, input, output).
- Display debug information for setup and troubleshooting.
## Installation
### Via HACS
1. Install [HACS](https://hacs.xyz/) if not already installed.
2. In Home Assistant, go to "HACS" in the sidebar.
3. Click on "Integrations."
2024-08-30 11:19:48 +02:00
4. Click on the three dots in the top right corner and select "Custom repositories."
5. Paste the following URL in the "Repo" field: https://github.com/M4TH1EU/HA-EasyComputerManager
6. Select "Integration" from the "Category" dropdown.
7. Click "Add."
8. Search for "easy_computer_manager" and click "Install."
2023-12-31 14:57:18 +01:00
### Manually
1. Download the latest release from the [GitHub repository](https://github.com/M4TH1EU/HA-EasyComputerManager/).
2. Extract the downloaded ZIP file.
2024-06-09 11:42:28 +02:00
3. Copy the "custom_components/easy_computer_manager" directory to the "config/custom_components/" directory in your
Home Assistant instance.
2023-12-31 14:57:18 +01:00
2024-08-30 11:19:48 +02:00
# Preparing your computer (required)
> [!CAUTION]
2024-08-30 11:31:13 +02:00
> Before adding your computer to Home Assistant, ensure that it is properly configured.
2024-08-30 11:19:48 +02:00
2024-08-30 11:31:13 +02:00
**See wiki page [here](https://github.com/M4TH1EU/HA-EasyComputerManager/wiki/Prepare-your-computer).**
2024-08-30 11:19:48 +02:00
## Add Computer to Home Assistant
2023-12-31 14:57:18 +01:00
1. In Home Assistant, go to "Configuration" in the sidebar.
2. Select "Integrations."
3. Click the "+" button to add a new integration.
4. Search for "Easy Computer Manager" and select it from the list.
2024-08-30 11:31:13 +02:00
5. Follow the on-screen instructions to configure the integration, providing details such as the IP address, mac-adress, username,
and password for the computer you want to add.
2023-12-31 14:57:18 +01:00
6. Once configured, click "Finish" to add the computer to Home Assistant.
2024-08-30 11:31:13 +02:00
> [!NOTE]
> If you are managing a dual-boot computer, ensure that the "Dual boot system" checkbox is enabled during the configuration.
2023-12-31 14:57:18 +01:00
## Usage
2024-06-09 11:42:28 +02:00
After adding your computer to Home Assistant, you can use the provided services to manage it remotely. Explore the
available services in the Home Assistant "Services" tab or use automations to integrate Easy Computer Manager into your
smart home setup.
2023-12-31 14:57:18 +01:00
2024-08-30 11:31:13 +02:00
## Services
A detailed list of available services and their parameters can be found in the wiki [here](https://github.com/M4TH1EU/HA-EasyComputerManager/wiki/Services).
2023-12-31 14:57:18 +01:00
## Troubleshooting
2024-06-09 11:42:28 +02:00
If you encounter any issues during installation or configuration, refer to the troubleshooting section in
the [Wiki](./wiki) or seek assistance from the Home Assistant community.
2023-12-31 14:57:18 +01:00
## Contributions
2024-06-09 11:42:28 +02:00
Contributions are welcome! If you find any bugs or have suggestions for improvements, please open an issue or submit a
pull request on the [GitHub repository](https://github.com/M4TH1EU/HA-EasyComputerManager).
2023-12-31 14:57:18 +01:00
Happy automating with Easy Computer Manager!