Compare commits
9 Commits
e4eeb2a97b
...
v0.1.1
| Author | SHA1 | Date | |
|---|---|---|---|
| b0d98a9d45 | |||
| d0d4958843 | |||
| de4b7cf9b4 | |||
| f84cfec43f | |||
| 6c5657618f | |||
| a37eb46003 | |||
| 83153dbddd | |||
| 02bdcc5d4b | |||
| 8cbe33eb72 |
@@ -0,0 +1,67 @@
|
|||||||
|
name: Release
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
tags:
|
||||||
|
- 'v*'
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
release:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- name: Fetch RELEASE_NOTES.md only
|
||||||
|
uses: actions/checkout@v4
|
||||||
|
with:
|
||||||
|
sparse-checkout: RELEASE_NOTES.md
|
||||||
|
sparse-checkout-cone-mode: false
|
||||||
|
|
||||||
|
- name: Create Gitea release
|
||||||
|
env:
|
||||||
|
DEPLOY_TOKEN: ${{ secrets.DEPLOY_TOKEN }}
|
||||||
|
run: |
|
||||||
|
TAG="${{ gitea.ref_name }}"
|
||||||
|
VERSION="${TAG#v}"
|
||||||
|
BASE_URL="${{ gitea.server_url }}/api/v1/repos/${{ gitea.repository }}"
|
||||||
|
|
||||||
|
# Detect pre-release (alpha/beta/rc)
|
||||||
|
IS_PRE="false"
|
||||||
|
if echo "$TAG" | grep -qE '(alpha|beta|rc)'; then
|
||||||
|
IS_PRE="true"
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Read release notes if present
|
||||||
|
if [ -f RELEASE_NOTES.md ]; then
|
||||||
|
export RELEASE_NOTES=$(cat RELEASE_NOTES.md)
|
||||||
|
echo "Found RELEASE_NOTES.md"
|
||||||
|
else
|
||||||
|
export RELEASE_NOTES=""
|
||||||
|
echo "No RELEASE_NOTES.md found"
|
||||||
|
fi
|
||||||
|
|
||||||
|
BODY_JSON=$(python3 -c "
|
||||||
|
import json, os
|
||||||
|
notes = os.environ.get('RELEASE_NOTES', '')
|
||||||
|
print(json.dumps(notes.strip()))
|
||||||
|
")
|
||||||
|
|
||||||
|
# Create release via Gitea API
|
||||||
|
RELEASE=$(curl -s -X POST "$BASE_URL/releases" \
|
||||||
|
-H "Authorization: token $DEPLOY_TOKEN" \
|
||||||
|
-H "Content-Type: application/json" \
|
||||||
|
-d "{
|
||||||
|
\"tag_name\": \"$TAG\",
|
||||||
|
\"name\": \"$VERSION\",
|
||||||
|
\"body\": $BODY_JSON,
|
||||||
|
\"draft\": false,
|
||||||
|
\"prerelease\": $IS_PRE
|
||||||
|
}")
|
||||||
|
|
||||||
|
# Fallback: if release already exists for this tag, reuse it
|
||||||
|
RELEASE_ID=$(echo "$RELEASE" | python3 -c "import sys,json; print(json.load(sys.stdin)['id'])" 2>/dev/null)
|
||||||
|
if [ -z "$RELEASE_ID" ]; then
|
||||||
|
echo "::warning::Release already exists for tag $TAG — reusing existing release"
|
||||||
|
RELEASE=$(curl -s "$BASE_URL/releases/tags/$TAG" \
|
||||||
|
-H "Authorization: token $DEPLOY_TOKEN")
|
||||||
|
RELEASE_ID=$(echo "$RELEASE" | python3 -c "import sys,json; print(json.load(sys.stdin)['id'])")
|
||||||
|
fi
|
||||||
|
echo "Created release $RELEASE_ID for $TAG"
|
||||||
@@ -103,6 +103,48 @@ Button entities for each script defined on your Media Server:
|
|||||||
- Shutdown, restart, sleep, hibernate
|
- Shutdown, restart, sleep, hibernate
|
||||||
- Custom scripts
|
- Custom scripts
|
||||||
|
|
||||||
|
### Execute Script Service
|
||||||
|
|
||||||
|
Call `remote_media_player.execute_script` to run any server-defined script with typed parameters:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
service: remote_media_player.execute_script
|
||||||
|
data:
|
||||||
|
script_name: set_brightness
|
||||||
|
params:
|
||||||
|
level: 75
|
||||||
|
monitor: primary
|
||||||
|
```
|
||||||
|
|
||||||
|
Parameters are validated against the script's schema on the server. Scripts define their parameters in `config.yaml`:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
scripts:
|
||||||
|
set_brightness:
|
||||||
|
command: "python set_brightness.py"
|
||||||
|
label: "Set Brightness"
|
||||||
|
icon: "mdi:brightness-6"
|
||||||
|
timeout: 10
|
||||||
|
parameters:
|
||||||
|
level:
|
||||||
|
type: integer
|
||||||
|
required: true
|
||||||
|
min: 0
|
||||||
|
max: 100
|
||||||
|
description: "Brightness level (0-100)"
|
||||||
|
monitor:
|
||||||
|
type: select
|
||||||
|
options: ["primary", "secondary", "all"]
|
||||||
|
default: "primary"
|
||||||
|
description: "Target monitor"
|
||||||
|
```
|
||||||
|
|
||||||
|
Supported parameter types: `string`, `integer`, `float`, `boolean`, `select`.
|
||||||
|
|
||||||
|
Parameters are passed to scripts as environment variables prefixed with `SCRIPT_PARAM_` (e.g., `SCRIPT_PARAM_LEVEL=75`, `SCRIPT_PARAM_MONITOR=primary`).
|
||||||
|
|
||||||
|
Scripts without parameters work as before — just omit `params`.
|
||||||
|
|
||||||
## Example Lovelace Card
|
## Example Lovelace Card
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
|
|||||||
@@ -0,0 +1,18 @@
|
|||||||
|
## v0.1.1 (2026-03-26)
|
||||||
|
|
||||||
|
### ⚠️ Breaking Changes
|
||||||
|
- Replace positional script `args` (list) with typed named `params` (dict) — update any automations calling `remote_media_player.execute_script` to use the new `params` format ([de4b7cf](https://git.dolgolyov-family.by/alexei.dolgolyov/haos-hacs-integration-media-player/commit/de4b7cf))
|
||||||
|
|
||||||
|
### Features
|
||||||
|
- Add execute_script service documentation to README ([de4b7cf](https://git.dolgolyov-family.by/alexei.dolgolyov/haos-hacs-integration-media-player/commit/de4b7cf))
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary>All Commits</summary>
|
||||||
|
|
||||||
|
| Hash | Message | Author |
|
||||||
|
|------|---------|--------|
|
||||||
|
| [de4b7cf](https://git.dolgolyov-family.by/alexei.dolgolyov/haos-hacs-integration-media-player/commit/de4b7cf) | feat: replace script args with typed named parameters | alexei.dolgolyov |
|
||||||
|
|
||||||
|
</details>
|
||||||
@@ -14,26 +14,33 @@ from homeassistant.helpers import config_validation as cv
|
|||||||
|
|
||||||
from .api_client import MediaServerClient, MediaServerError
|
from .api_client import MediaServerClient, MediaServerError
|
||||||
from .const import (
|
from .const import (
|
||||||
ATTR_SCRIPT_ARGS,
|
ATTR_FILE_PATH,
|
||||||
ATTR_SCRIPT_NAME,
|
ATTR_SCRIPT_NAME,
|
||||||
|
ATTR_SCRIPT_PARAMS,
|
||||||
CONF_HOST,
|
CONF_HOST,
|
||||||
CONF_PORT,
|
CONF_PORT,
|
||||||
CONF_TOKEN,
|
CONF_TOKEN,
|
||||||
DOMAIN,
|
DOMAIN,
|
||||||
SERVICE_EXECUTE_SCRIPT,
|
SERVICE_EXECUTE_SCRIPT,
|
||||||
|
SERVICE_PLAY_MEDIA_FILE,
|
||||||
)
|
)
|
||||||
|
|
||||||
_LOGGER = logging.getLogger(__name__)
|
_LOGGER = logging.getLogger(__name__)
|
||||||
|
|
||||||
PLATFORMS: list[Platform] = [Platform.MEDIA_PLAYER, Platform.BUTTON]
|
PLATFORMS: list[Platform] = [Platform.MEDIA_PLAYER, Platform.BUTTON, Platform.NUMBER, Platform.SWITCH]
|
||||||
|
|
||||||
# Service schema for execute_script
|
# Service schema for execute_script
|
||||||
SERVICE_EXECUTE_SCRIPT_SCHEMA = vol.Schema(
|
SERVICE_EXECUTE_SCRIPT_SCHEMA = vol.Schema(
|
||||||
{
|
{
|
||||||
vol.Required(ATTR_SCRIPT_NAME): cv.string,
|
vol.Required(ATTR_SCRIPT_NAME): cv.string,
|
||||||
vol.Optional(ATTR_SCRIPT_ARGS, default=[]): vol.All(
|
vol.Optional(ATTR_SCRIPT_PARAMS, default={}): dict,
|
||||||
cv.ensure_list, [cv.string]
|
}
|
||||||
),
|
)
|
||||||
|
|
||||||
|
# Service schema for play_media_file
|
||||||
|
SERVICE_PLAY_MEDIA_FILE_SCHEMA = vol.Schema(
|
||||||
|
{
|
||||||
|
vol.Required(ATTR_FILE_PATH): cv.string,
|
||||||
}
|
}
|
||||||
)
|
)
|
||||||
|
|
||||||
@@ -74,10 +81,10 @@ async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
|
|||||||
async def async_execute_script(call: ServiceCall) -> dict[str, Any]:
|
async def async_execute_script(call: ServiceCall) -> dict[str, Any]:
|
||||||
"""Execute a script on the media server."""
|
"""Execute a script on the media server."""
|
||||||
script_name = call.data[ATTR_SCRIPT_NAME]
|
script_name = call.data[ATTR_SCRIPT_NAME]
|
||||||
script_args = call.data.get(ATTR_SCRIPT_ARGS, [])
|
script_params = call.data.get(ATTR_SCRIPT_PARAMS, {})
|
||||||
|
|
||||||
_LOGGER.debug(
|
_LOGGER.debug(
|
||||||
"Executing script '%s' with args: %s", script_name, script_args
|
"Executing script '%s' with params: %s", script_name, script_params
|
||||||
)
|
)
|
||||||
|
|
||||||
# Get all clients and execute on all of them
|
# Get all clients and execute on all of them
|
||||||
@@ -85,7 +92,7 @@ async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
|
|||||||
for entry_id, data in hass.data[DOMAIN].items():
|
for entry_id, data in hass.data[DOMAIN].items():
|
||||||
client: MediaServerClient = data["client"]
|
client: MediaServerClient = data["client"]
|
||||||
try:
|
try:
|
||||||
result = await client.execute_script(script_name, script_args)
|
result = await client.execute_script(script_name, script_params)
|
||||||
results[entry_id] = result
|
results[entry_id] = result
|
||||||
_LOGGER.info(
|
_LOGGER.info(
|
||||||
"Script '%s' executed on %s: success=%s",
|
"Script '%s' executed on %s: success=%s",
|
||||||
@@ -111,6 +118,29 @@ async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
|
|||||||
schema=SERVICE_EXECUTE_SCRIPT_SCHEMA,
|
schema=SERVICE_EXECUTE_SCRIPT_SCHEMA,
|
||||||
)
|
)
|
||||||
|
|
||||||
|
# Register play_media_file service if not already registered
|
||||||
|
if not hass.services.has_service(DOMAIN, SERVICE_PLAY_MEDIA_FILE):
|
||||||
|
async def async_play_media_file(call: ServiceCall) -> None:
|
||||||
|
"""Handle play_media_file service call."""
|
||||||
|
file_path = call.data[ATTR_FILE_PATH]
|
||||||
|
_LOGGER.debug("Service play_media_file called with path: %s", file_path)
|
||||||
|
|
||||||
|
# Execute on all configured media server instances
|
||||||
|
for entry_id, data in hass.data[DOMAIN].items():
|
||||||
|
client: MediaServerClient = data["client"]
|
||||||
|
try:
|
||||||
|
await client.play_media_file(file_path)
|
||||||
|
_LOGGER.info("Started playback of %s on %s", file_path, entry_id)
|
||||||
|
except MediaServerError as err:
|
||||||
|
_LOGGER.error("Failed to play %s on %s: %s", file_path, entry_id, err)
|
||||||
|
|
||||||
|
hass.services.async_register(
|
||||||
|
DOMAIN,
|
||||||
|
SERVICE_PLAY_MEDIA_FILE,
|
||||||
|
async_play_media_file,
|
||||||
|
schema=SERVICE_PLAY_MEDIA_FILE_SCHEMA,
|
||||||
|
)
|
||||||
|
|
||||||
# Forward setup to platforms
|
# Forward setup to platforms
|
||||||
await hass.config_entries.async_forward_entry_setups(entry, PLATFORMS)
|
await hass.config_entries.async_forward_entry_setups(entry, PLATFORMS)
|
||||||
|
|
||||||
@@ -149,6 +179,7 @@ async def async_unload_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
|
|||||||
# Remove services if this was the last entry
|
# Remove services if this was the last entry
|
||||||
if not hass.data[DOMAIN]:
|
if not hass.data[DOMAIN]:
|
||||||
hass.services.async_remove(DOMAIN, SERVICE_EXECUTE_SCRIPT)
|
hass.services.async_remove(DOMAIN, SERVICE_EXECUTE_SCRIPT)
|
||||||
|
hass.services.async_remove(DOMAIN, SERVICE_PLAY_MEDIA_FILE)
|
||||||
|
|
||||||
return unload_ok
|
return unload_ok
|
||||||
|
|
||||||
|
|||||||
@@ -27,6 +27,12 @@ from .const import (
|
|||||||
API_TOGGLE,
|
API_TOGGLE,
|
||||||
API_SCRIPTS_LIST,
|
API_SCRIPTS_LIST,
|
||||||
API_SCRIPTS_EXECUTE,
|
API_SCRIPTS_EXECUTE,
|
||||||
|
API_BROWSER_FOLDERS,
|
||||||
|
API_BROWSER_BROWSE,
|
||||||
|
API_BROWSER_PLAY,
|
||||||
|
API_DISPLAY_MONITORS,
|
||||||
|
API_DISPLAY_BRIGHTNESS,
|
||||||
|
API_DISPLAY_POWER,
|
||||||
)
|
)
|
||||||
|
|
||||||
_LOGGER = logging.getLogger(__name__)
|
_LOGGER = logging.getLogger(__name__)
|
||||||
@@ -281,21 +287,102 @@ class MediaServerClient:
|
|||||||
return await self._request("GET", API_SCRIPTS_LIST)
|
return await self._request("GET", API_SCRIPTS_LIST)
|
||||||
|
|
||||||
async def execute_script(
|
async def execute_script(
|
||||||
self, script_name: str, args: list[str] | None = None
|
self,
|
||||||
|
script_name: str,
|
||||||
|
params: dict[str, str | int | float | bool] | None = None,
|
||||||
) -> dict[str, Any]:
|
) -> dict[str, Any]:
|
||||||
"""Execute a script on the server.
|
"""Execute a script on the server.
|
||||||
|
|
||||||
Args:
|
Args:
|
||||||
script_name: Name of the script to execute
|
script_name: Name of the script to execute
|
||||||
args: Optional list of arguments to pass to the script
|
params: Optional named parameters (validated against script schema)
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
Execution result with success, exit_code, stdout, stderr
|
Execution result with success, exit_code, stdout, stderr
|
||||||
"""
|
"""
|
||||||
endpoint = f"{API_SCRIPTS_EXECUTE}/{script_name}"
|
endpoint = f"{API_SCRIPTS_EXECUTE}/{script_name}"
|
||||||
json_data = {"args": args or []}
|
json_data = {"params": params or {}}
|
||||||
return await self._request("POST", endpoint, json_data)
|
return await self._request("POST", endpoint, json_data)
|
||||||
|
|
||||||
|
async def get_media_folders(self) -> dict[str, dict[str, Any]]:
|
||||||
|
"""Get configured media folders.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
Dictionary of folders with folder_id as key and folder config as value
|
||||||
|
"""
|
||||||
|
return await self._request("GET", API_BROWSER_FOLDERS)
|
||||||
|
|
||||||
|
async def browse_folder(
|
||||||
|
self, folder_id: str, path: str = "", offset: int = 0, limit: int = 100
|
||||||
|
) -> dict[str, Any]:
|
||||||
|
"""Browse a media folder.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
folder_id: ID of the folder to browse
|
||||||
|
path: Path within the folder (empty for root)
|
||||||
|
offset: Pagination offset
|
||||||
|
limit: Number of items to return
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
Dictionary with current_path, parent_path, items, total, offset, limit
|
||||||
|
"""
|
||||||
|
params = {
|
||||||
|
"folder_id": folder_id,
|
||||||
|
"path": path,
|
||||||
|
"offset": offset,
|
||||||
|
"limit": limit,
|
||||||
|
}
|
||||||
|
query_string = "&".join(f"{k}={v}" for k, v in params.items())
|
||||||
|
endpoint = f"{API_BROWSER_BROWSE}?{query_string}"
|
||||||
|
return await self._request("GET", endpoint)
|
||||||
|
|
||||||
|
async def play_media_file(self, file_path: str) -> dict[str, Any]:
|
||||||
|
"""Play a media file by absolute path.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
file_path: Absolute path to the media file
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
Response data with success status
|
||||||
|
"""
|
||||||
|
return await self._request("POST", API_BROWSER_PLAY, {"path": file_path})
|
||||||
|
|
||||||
|
async def get_display_monitors(self) -> list[dict[str, Any]]:
|
||||||
|
"""Get list of connected monitors with brightness and power info.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
List of monitor dicts with id, name, brightness, power_supported, power_on, resolution
|
||||||
|
"""
|
||||||
|
return await self._request("GET", f"{API_DISPLAY_MONITORS}?refresh=true")
|
||||||
|
|
||||||
|
async def set_display_brightness(self, monitor_id: int, brightness: int) -> dict[str, Any]:
|
||||||
|
"""Set brightness for a specific monitor.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
monitor_id: Monitor index
|
||||||
|
brightness: Brightness level (0-100)
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
Response data with success status
|
||||||
|
"""
|
||||||
|
return await self._request(
|
||||||
|
"POST", f"{API_DISPLAY_BRIGHTNESS}/{monitor_id}", {"brightness": brightness}
|
||||||
|
)
|
||||||
|
|
||||||
|
async def set_display_power(self, monitor_id: int, on: bool) -> dict[str, Any]:
|
||||||
|
"""Set power state for a specific monitor.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
monitor_id: Monitor index
|
||||||
|
on: True to turn on, False to turn off
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
Response data with success status
|
||||||
|
"""
|
||||||
|
return await self._request(
|
||||||
|
"POST", f"{API_DISPLAY_POWER}/{monitor_id}", {"on": on}
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
class MediaServerWebSocket:
|
class MediaServerWebSocket:
|
||||||
"""WebSocket client for real-time media status updates."""
|
"""WebSocket client for real-time media status updates."""
|
||||||
|
|||||||
@@ -34,10 +34,18 @@ API_TOGGLE = "/api/media/toggle"
|
|||||||
API_SCRIPTS_LIST = "/api/scripts/list"
|
API_SCRIPTS_LIST = "/api/scripts/list"
|
||||||
API_SCRIPTS_EXECUTE = "/api/scripts/execute"
|
API_SCRIPTS_EXECUTE = "/api/scripts/execute"
|
||||||
API_WEBSOCKET = "/api/media/ws"
|
API_WEBSOCKET = "/api/media/ws"
|
||||||
|
API_BROWSER_FOLDERS = "/api/browser/folders"
|
||||||
|
API_BROWSER_BROWSE = "/api/browser/browse"
|
||||||
|
API_BROWSER_PLAY = "/api/browser/play"
|
||||||
|
API_DISPLAY_MONITORS = "/api/display/monitors"
|
||||||
|
API_DISPLAY_BRIGHTNESS = "/api/display/brightness"
|
||||||
|
API_DISPLAY_POWER = "/api/display/power"
|
||||||
|
|
||||||
# Service names
|
# Service names
|
||||||
SERVICE_EXECUTE_SCRIPT = "execute_script"
|
SERVICE_EXECUTE_SCRIPT = "execute_script"
|
||||||
|
SERVICE_PLAY_MEDIA_FILE = "play_media_file"
|
||||||
|
|
||||||
# Service attributes
|
# Service attributes
|
||||||
ATTR_SCRIPT_NAME = "script_name"
|
ATTR_SCRIPT_NAME = "script_name"
|
||||||
ATTR_SCRIPT_ARGS = "args"
|
ATTR_SCRIPT_PARAMS = "params"
|
||||||
|
ATTR_FILE_PATH = "file_path"
|
||||||
|
|||||||
@@ -8,5 +8,5 @@
|
|||||||
"integration_type": "device",
|
"integration_type": "device",
|
||||||
"iot_class": "local_push",
|
"iot_class": "local_push",
|
||||||
"requirements": ["aiohttp>=3.8.0"],
|
"requirements": ["aiohttp>=3.8.0"],
|
||||||
"version": "1.0.0"
|
"version": "0.1.1"
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -8,11 +8,16 @@ from datetime import datetime, timedelta
|
|||||||
from typing import Any
|
from typing import Any
|
||||||
|
|
||||||
from homeassistant.components.media_player import (
|
from homeassistant.components.media_player import (
|
||||||
|
BrowseMedia,
|
||||||
MediaPlayerEntity,
|
MediaPlayerEntity,
|
||||||
MediaPlayerEntityFeature,
|
MediaPlayerEntityFeature,
|
||||||
MediaPlayerState,
|
MediaPlayerState,
|
||||||
MediaType,
|
MediaType,
|
||||||
)
|
)
|
||||||
|
from homeassistant.components.media_player.const import (
|
||||||
|
MediaClass,
|
||||||
|
)
|
||||||
|
from urllib.parse import quote, unquote
|
||||||
from homeassistant.config_entries import ConfigEntry
|
from homeassistant.config_entries import ConfigEntry
|
||||||
from homeassistant.const import CONF_NAME
|
from homeassistant.const import CONF_NAME
|
||||||
from homeassistant.core import HomeAssistant, callback
|
from homeassistant.core import HomeAssistant, callback
|
||||||
@@ -194,6 +199,10 @@ class MediaPlayerCoordinator(DataUpdateCoordinator[dict[str, Any]]):
|
|||||||
# Re-enable polling as fallback
|
# Re-enable polling as fallback
|
||||||
self.update_interval = timedelta(seconds=self._poll_interval)
|
self.update_interval = timedelta(seconds=self._poll_interval)
|
||||||
_LOGGER.warning("WebSocket disconnected, falling back to polling")
|
_LOGGER.warning("WebSocket disconnected, falling back to polling")
|
||||||
|
# Trigger an immediate refresh to restart the polling loop.
|
||||||
|
# Without this, the polling loop stays stopped (it was disabled when
|
||||||
|
# WebSocket was active) and the entity never becomes unavailable.
|
||||||
|
self.hass.async_create_task(self.async_request_refresh())
|
||||||
# Schedule reconnect attempt
|
# Schedule reconnect attempt
|
||||||
self._schedule_reconnect()
|
self._schedule_reconnect()
|
||||||
|
|
||||||
@@ -303,6 +312,8 @@ class RemoteMediaPlayerEntity(CoordinatorEntity[MediaPlayerCoordinator], MediaPl
|
|||||||
| MediaPlayerEntityFeature.SEEK
|
| MediaPlayerEntityFeature.SEEK
|
||||||
| MediaPlayerEntityFeature.TURN_ON
|
| MediaPlayerEntityFeature.TURN_ON
|
||||||
| MediaPlayerEntityFeature.TURN_OFF
|
| MediaPlayerEntityFeature.TURN_OFF
|
||||||
|
| MediaPlayerEntityFeature.BROWSE_MEDIA
|
||||||
|
| MediaPlayerEntityFeature.PLAY_MEDIA
|
||||||
)
|
)
|
||||||
|
|
||||||
@property
|
@property
|
||||||
@@ -374,7 +385,12 @@ class RemoteMediaPlayerEntity(CoordinatorEntity[MediaPlayerCoordinator], MediaPl
|
|||||||
if self.coordinator.data is None:
|
if self.coordinator.data is None:
|
||||||
return None
|
return None
|
||||||
duration = self.coordinator.data.get("duration")
|
duration = self.coordinator.data.get("duration")
|
||||||
return int(duration) if duration is not None else None
|
if duration is None:
|
||||||
|
return None
|
||||||
|
try:
|
||||||
|
return int(duration)
|
||||||
|
except (ValueError, TypeError):
|
||||||
|
return None
|
||||||
|
|
||||||
@property
|
@property
|
||||||
def media_position(self) -> int | None:
|
def media_position(self) -> int | None:
|
||||||
@@ -382,7 +398,12 @@ class RemoteMediaPlayerEntity(CoordinatorEntity[MediaPlayerCoordinator], MediaPl
|
|||||||
if self.coordinator.data is None:
|
if self.coordinator.data is None:
|
||||||
return None
|
return None
|
||||||
position = self.coordinator.data.get("position")
|
position = self.coordinator.data.get("position")
|
||||||
return int(position) if position is not None else None
|
if position is None:
|
||||||
|
return None
|
||||||
|
try:
|
||||||
|
return int(position)
|
||||||
|
except (ValueError, TypeError):
|
||||||
|
return None
|
||||||
|
|
||||||
@property
|
@property
|
||||||
def media_position_updated_at(self) -> datetime | None:
|
def media_position_updated_at(self) -> datetime | None:
|
||||||
@@ -489,3 +510,151 @@ class RemoteMediaPlayerEntity(CoordinatorEntity[MediaPlayerCoordinator], MediaPl
|
|||||||
await self.coordinator.client.toggle()
|
await self.coordinator.client.toggle()
|
||||||
except MediaServerError as err:
|
except MediaServerError as err:
|
||||||
_LOGGER.error("Failed to toggle: %s", err)
|
_LOGGER.error("Failed to toggle: %s", err)
|
||||||
|
|
||||||
|
# Media Browser support
|
||||||
|
|
||||||
|
@staticmethod
|
||||||
|
def _encode_media_id(folder_id: str, path: str = "") -> str:
|
||||||
|
"""Encode folder_id and path into media_content_id.
|
||||||
|
|
||||||
|
Format: folder_id|encoded_path
|
||||||
|
Root folder: folder_id|
|
||||||
|
"""
|
||||||
|
return f"{folder_id}|{quote(path, safe='')}"
|
||||||
|
|
||||||
|
@staticmethod
|
||||||
|
def _decode_media_id(media_content_id: str) -> tuple[str, str]:
|
||||||
|
"""Decode media_content_id into folder_id and path.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
Tuple of (folder_id, path)
|
||||||
|
"""
|
||||||
|
if not media_content_id or "|" not in media_content_id:
|
||||||
|
return "", ""
|
||||||
|
folder_id, encoded_path = media_content_id.split("|", 1)
|
||||||
|
path = unquote(encoded_path) if encoded_path else ""
|
||||||
|
return folder_id, path
|
||||||
|
|
||||||
|
async def async_browse_media(
|
||||||
|
self,
|
||||||
|
media_content_type: str | None = None,
|
||||||
|
media_content_id: str | None = None,
|
||||||
|
) -> BrowseMedia:
|
||||||
|
"""Implement the media browsing.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
media_content_type: Type of media (unused, but required by HA)
|
||||||
|
media_content_id: ID in format "folder_id|path" or None for root
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
BrowseMedia object with children
|
||||||
|
"""
|
||||||
|
_LOGGER.debug("Browse media: type=%s, id=%s", media_content_type, media_content_id)
|
||||||
|
|
||||||
|
# Root level - list all folders
|
||||||
|
if not media_content_id:
|
||||||
|
folders = await self.coordinator.client.get_media_folders()
|
||||||
|
|
||||||
|
children = [
|
||||||
|
BrowseMedia(
|
||||||
|
title=config["label"],
|
||||||
|
media_class=MediaClass.DIRECTORY,
|
||||||
|
media_content_type=MediaType.MUSIC, # All folders show as music
|
||||||
|
media_content_id=self._encode_media_id(folder_id, ""),
|
||||||
|
can_play=False,
|
||||||
|
can_expand=True,
|
||||||
|
)
|
||||||
|
for folder_id, config in folders.items()
|
||||||
|
if config.get("enabled", True)
|
||||||
|
]
|
||||||
|
|
||||||
|
return BrowseMedia(
|
||||||
|
title="Media Folders",
|
||||||
|
media_class=MediaClass.DIRECTORY,
|
||||||
|
media_content_type=MediaType.MUSIC,
|
||||||
|
media_content_id="",
|
||||||
|
can_play=False,
|
||||||
|
can_expand=True,
|
||||||
|
children=children,
|
||||||
|
)
|
||||||
|
|
||||||
|
# Browse specific folder
|
||||||
|
folder_id, path = self._decode_media_id(media_content_id)
|
||||||
|
|
||||||
|
if not folder_id:
|
||||||
|
raise ValueError("Invalid media_content_id format")
|
||||||
|
|
||||||
|
# Get folder contents from API
|
||||||
|
browse_data = await self.coordinator.client.browse_folder(folder_id, path, offset=0, limit=5000)
|
||||||
|
|
||||||
|
# Fetch folder metadata once (not per-item) for building absolute paths
|
||||||
|
folders = await self.coordinator.client.get_media_folders()
|
||||||
|
base_path = folders.get(folder_id, {}).get("path", "")
|
||||||
|
# Detect path separator from server's base_path (Unix vs Windows)
|
||||||
|
separator = '\\' if '\\' in base_path else '/'
|
||||||
|
base_path_clean = base_path.rstrip('/\\')
|
||||||
|
|
||||||
|
children = []
|
||||||
|
for item in browse_data.get("items", []):
|
||||||
|
if item["type"] == "folder":
|
||||||
|
# Subfolder
|
||||||
|
item_path = f"{path}/{item['name']}" if path else item['name']
|
||||||
|
children.append(
|
||||||
|
BrowseMedia(
|
||||||
|
title=item["name"],
|
||||||
|
media_class=MediaClass.DIRECTORY,
|
||||||
|
media_content_type=MediaType.MUSIC,
|
||||||
|
media_content_id=self._encode_media_id(folder_id, item_path),
|
||||||
|
can_play=False,
|
||||||
|
can_expand=True,
|
||||||
|
)
|
||||||
|
)
|
||||||
|
elif item.get("is_media", False):
|
||||||
|
# Media file - build absolute path for playback
|
||||||
|
file_path_in_folder = f"{path}/{item['name']}" if path else item['name']
|
||||||
|
absolute_path = f"{base_path_clean}{separator}{file_path_in_folder.replace('/', separator)}"
|
||||||
|
|
||||||
|
children.append(
|
||||||
|
BrowseMedia(
|
||||||
|
title=item["name"],
|
||||||
|
media_class=MediaClass.MUSIC,
|
||||||
|
media_content_type=MediaType.MUSIC,
|
||||||
|
media_content_id=absolute_path, # Use absolute path as ID for playback
|
||||||
|
can_play=True,
|
||||||
|
can_expand=False,
|
||||||
|
)
|
||||||
|
)
|
||||||
|
|
||||||
|
# Get current folder label
|
||||||
|
current_title = path.split("/")[-1] if path else browse_data.get("label", folder_id)
|
||||||
|
|
||||||
|
return BrowseMedia(
|
||||||
|
title=current_title,
|
||||||
|
media_class=MediaClass.DIRECTORY,
|
||||||
|
media_content_type=MediaType.MUSIC,
|
||||||
|
media_content_id=media_content_id,
|
||||||
|
can_play=False,
|
||||||
|
can_expand=True,
|
||||||
|
children=children,
|
||||||
|
)
|
||||||
|
|
||||||
|
async def async_play_media(
|
||||||
|
self, media_type: str, media_id: str, **kwargs: Any
|
||||||
|
) -> None:
|
||||||
|
"""Play a media file.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
media_type: Type of media (unused)
|
||||||
|
media_id: Absolute file path to media file
|
||||||
|
**kwargs: Additional arguments (unused)
|
||||||
|
"""
|
||||||
|
_LOGGER.debug("Play media: type=%s, id=%s", media_type, media_id)
|
||||||
|
|
||||||
|
try:
|
||||||
|
# media_id is the absolute file path from browse_media
|
||||||
|
await self.coordinator.client.play_media_file(media_id)
|
||||||
|
|
||||||
|
# Request immediate status update
|
||||||
|
await self.coordinator.async_request_refresh()
|
||||||
|
except MediaServerError as err:
|
||||||
|
_LOGGER.error("Failed to play media file: %s", err)
|
||||||
|
|||||||
@@ -0,0 +1,110 @@
|
|||||||
|
"""Number platform for Remote Media Player integration (display brightness)."""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import logging
|
||||||
|
from typing import Any
|
||||||
|
|
||||||
|
from homeassistant.components.number import NumberEntity, NumberMode
|
||||||
|
from homeassistant.config_entries import ConfigEntry
|
||||||
|
from homeassistant.core import HomeAssistant
|
||||||
|
from homeassistant.helpers.entity import DeviceInfo
|
||||||
|
from homeassistant.helpers.entity_platform import AddEntitiesCallback
|
||||||
|
|
||||||
|
from .api_client import MediaServerClient, MediaServerError
|
||||||
|
from .const import DOMAIN
|
||||||
|
|
||||||
|
_LOGGER = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
async def async_setup_entry(
|
||||||
|
hass: HomeAssistant,
|
||||||
|
entry: ConfigEntry,
|
||||||
|
async_add_entities: AddEntitiesCallback,
|
||||||
|
) -> None:
|
||||||
|
"""Set up display brightness number entities from a config entry."""
|
||||||
|
client: MediaServerClient = hass.data[DOMAIN][entry.entry_id]["client"]
|
||||||
|
|
||||||
|
try:
|
||||||
|
monitors = await client.get_display_monitors()
|
||||||
|
except MediaServerError as err:
|
||||||
|
_LOGGER.error("Failed to fetch display monitors: %s", err)
|
||||||
|
return
|
||||||
|
|
||||||
|
entities = [
|
||||||
|
DisplayBrightnessNumber(
|
||||||
|
client=client,
|
||||||
|
entry=entry,
|
||||||
|
monitor=monitor,
|
||||||
|
)
|
||||||
|
for monitor in monitors
|
||||||
|
if monitor.get("brightness") is not None
|
||||||
|
]
|
||||||
|
|
||||||
|
if entities:
|
||||||
|
async_add_entities(entities)
|
||||||
|
_LOGGER.info("Added %d display brightness entities", len(entities))
|
||||||
|
|
||||||
|
|
||||||
|
class DisplayBrightnessNumber(NumberEntity):
|
||||||
|
"""Number entity for controlling display brightness."""
|
||||||
|
|
||||||
|
_attr_has_entity_name = True
|
||||||
|
_attr_native_min_value = 0
|
||||||
|
_attr_native_max_value = 100
|
||||||
|
_attr_native_step = 1
|
||||||
|
_attr_native_unit_of_measurement = "%"
|
||||||
|
_attr_mode = NumberMode.SLIDER
|
||||||
|
_attr_icon = "mdi:brightness-6"
|
||||||
|
|
||||||
|
def __init__(
|
||||||
|
self,
|
||||||
|
client: MediaServerClient,
|
||||||
|
entry: ConfigEntry,
|
||||||
|
monitor: dict[str, Any],
|
||||||
|
) -> None:
|
||||||
|
"""Initialize the display brightness entity."""
|
||||||
|
self._client = client
|
||||||
|
self._entry = entry
|
||||||
|
self._monitor_id: int = monitor["id"]
|
||||||
|
self._monitor_name: str = monitor.get("name", f"Monitor {monitor['id']}")
|
||||||
|
self._resolution: str | None = monitor.get("resolution")
|
||||||
|
self._attr_native_value = monitor.get("brightness")
|
||||||
|
|
||||||
|
# Use resolution in name to disambiguate same-name monitors
|
||||||
|
display_name = self._monitor_name
|
||||||
|
if self._resolution:
|
||||||
|
display_name = f"{self._monitor_name} ({self._resolution})"
|
||||||
|
|
||||||
|
self._attr_unique_id = f"{entry.entry_id}_display_brightness_{self._monitor_id}"
|
||||||
|
self._attr_name = f"Display {display_name} Brightness"
|
||||||
|
|
||||||
|
@property
|
||||||
|
def device_info(self) -> DeviceInfo:
|
||||||
|
"""Return device info."""
|
||||||
|
return DeviceInfo(
|
||||||
|
identifiers={(DOMAIN, self._entry.entry_id)},
|
||||||
|
name=self._entry.title,
|
||||||
|
manufacturer="Remote Media Player",
|
||||||
|
model="Media Server",
|
||||||
|
)
|
||||||
|
|
||||||
|
async def async_set_native_value(self, value: float) -> None:
|
||||||
|
"""Set the brightness value."""
|
||||||
|
try:
|
||||||
|
await self._client.set_display_brightness(self._monitor_id, int(value))
|
||||||
|
self._attr_native_value = int(value)
|
||||||
|
self.async_write_ha_state()
|
||||||
|
except MediaServerError as err:
|
||||||
|
_LOGGER.error("Failed to set brightness for monitor %d: %s", self._monitor_id, err)
|
||||||
|
|
||||||
|
async def async_update(self) -> None:
|
||||||
|
"""Fetch updated brightness from the server."""
|
||||||
|
try:
|
||||||
|
monitors = await self._client.get_display_monitors()
|
||||||
|
for monitor in monitors:
|
||||||
|
if monitor["id"] == self._monitor_id:
|
||||||
|
self._attr_native_value = monitor.get("brightness")
|
||||||
|
break
|
||||||
|
except MediaServerError as err:
|
||||||
|
_LOGGER.error("Failed to update brightness for monitor %d: %s", self._monitor_id, err)
|
||||||
@@ -9,10 +9,10 @@ execute_script:
|
|||||||
example: "launch_spotify"
|
example: "launch_spotify"
|
||||||
selector:
|
selector:
|
||||||
text:
|
text:
|
||||||
args:
|
params:
|
||||||
name: Arguments
|
name: Parameters
|
||||||
description: Optional list of arguments to pass to the script
|
description: Optional named parameters to pass to the script (validated against script schema)
|
||||||
required: false
|
required: false
|
||||||
example: '["arg1", "arg2"]'
|
example: '{"level": 75, "monitor": "primary"}'
|
||||||
selector:
|
selector:
|
||||||
object:
|
object:
|
||||||
|
|||||||
@@ -0,0 +1,125 @@
|
|||||||
|
"""Switch platform for Remote Media Player integration (display power)."""
|
||||||
|
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import logging
|
||||||
|
from typing import Any
|
||||||
|
|
||||||
|
from homeassistant.components.switch import SwitchEntity, SwitchDeviceClass
|
||||||
|
from homeassistant.config_entries import ConfigEntry
|
||||||
|
from homeassistant.core import HomeAssistant
|
||||||
|
from homeassistant.helpers.entity import DeviceInfo
|
||||||
|
from homeassistant.helpers.entity_platform import AddEntitiesCallback
|
||||||
|
|
||||||
|
from .api_client import MediaServerClient, MediaServerError
|
||||||
|
from .const import DOMAIN
|
||||||
|
|
||||||
|
_LOGGER = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
async def async_setup_entry(
|
||||||
|
hass: HomeAssistant,
|
||||||
|
entry: ConfigEntry,
|
||||||
|
async_add_entities: AddEntitiesCallback,
|
||||||
|
) -> None:
|
||||||
|
"""Set up display power switch entities from a config entry."""
|
||||||
|
client: MediaServerClient = hass.data[DOMAIN][entry.entry_id]["client"]
|
||||||
|
|
||||||
|
try:
|
||||||
|
monitors = await client.get_display_monitors()
|
||||||
|
except MediaServerError as err:
|
||||||
|
_LOGGER.error("Failed to fetch display monitors: %s", err)
|
||||||
|
return
|
||||||
|
|
||||||
|
entities = [
|
||||||
|
DisplayPowerSwitch(
|
||||||
|
client=client,
|
||||||
|
entry=entry,
|
||||||
|
monitor=monitor,
|
||||||
|
)
|
||||||
|
for monitor in monitors
|
||||||
|
if monitor.get("power_supported", False)
|
||||||
|
]
|
||||||
|
|
||||||
|
if entities:
|
||||||
|
async_add_entities(entities)
|
||||||
|
_LOGGER.info("Added %d display power switch entities", len(entities))
|
||||||
|
|
||||||
|
|
||||||
|
class DisplayPowerSwitch(SwitchEntity):
|
||||||
|
"""Switch entity for controlling display power."""
|
||||||
|
|
||||||
|
_attr_has_entity_name = True
|
||||||
|
_attr_device_class = SwitchDeviceClass.SWITCH
|
||||||
|
|
||||||
|
def __init__(
|
||||||
|
self,
|
||||||
|
client: MediaServerClient,
|
||||||
|
entry: ConfigEntry,
|
||||||
|
monitor: dict[str, Any],
|
||||||
|
) -> None:
|
||||||
|
"""Initialize the display power switch."""
|
||||||
|
self._client = client
|
||||||
|
self._entry = entry
|
||||||
|
self._monitor_id: int = monitor["id"]
|
||||||
|
self._monitor_name: str = monitor.get("name", f"Monitor {monitor['id']}")
|
||||||
|
self._resolution: str | None = monitor.get("resolution")
|
||||||
|
self._attr_is_on = monitor.get("power_on", True)
|
||||||
|
|
||||||
|
# Use resolution in name to disambiguate same-name monitors
|
||||||
|
display_name = self._monitor_name
|
||||||
|
if self._resolution:
|
||||||
|
display_name = f"{self._monitor_name} ({self._resolution})"
|
||||||
|
|
||||||
|
self._attr_unique_id = f"{entry.entry_id}_display_power_{self._monitor_id}"
|
||||||
|
self._attr_name = f"Display {display_name} Power"
|
||||||
|
|
||||||
|
@property
|
||||||
|
def icon(self) -> str:
|
||||||
|
"""Return icon based on power state."""
|
||||||
|
return "mdi:monitor" if self._attr_is_on else "mdi:monitor-off"
|
||||||
|
|
||||||
|
@property
|
||||||
|
def device_info(self) -> DeviceInfo:
|
||||||
|
"""Return device info."""
|
||||||
|
return DeviceInfo(
|
||||||
|
identifiers={(DOMAIN, self._entry.entry_id)},
|
||||||
|
name=self._entry.title,
|
||||||
|
manufacturer="Remote Media Player",
|
||||||
|
model="Media Server",
|
||||||
|
)
|
||||||
|
|
||||||
|
async def async_turn_on(self, **kwargs: Any) -> None:
|
||||||
|
"""Turn the monitor on."""
|
||||||
|
try:
|
||||||
|
result = await self._client.set_display_power(self._monitor_id, True)
|
||||||
|
if result.get("success"):
|
||||||
|
self._attr_is_on = True
|
||||||
|
self.async_write_ha_state()
|
||||||
|
else:
|
||||||
|
_LOGGER.error("Failed to turn on monitor %d", self._monitor_id)
|
||||||
|
except MediaServerError as err:
|
||||||
|
_LOGGER.error("Failed to turn on monitor %d: %s", self._monitor_id, err)
|
||||||
|
|
||||||
|
async def async_turn_off(self, **kwargs: Any) -> None:
|
||||||
|
"""Turn the monitor off."""
|
||||||
|
try:
|
||||||
|
result = await self._client.set_display_power(self._monitor_id, False)
|
||||||
|
if result.get("success"):
|
||||||
|
self._attr_is_on = False
|
||||||
|
self.async_write_ha_state()
|
||||||
|
else:
|
||||||
|
_LOGGER.error("Failed to turn off monitor %d", self._monitor_id)
|
||||||
|
except MediaServerError as err:
|
||||||
|
_LOGGER.error("Failed to turn off monitor %d: %s", self._monitor_id, err)
|
||||||
|
|
||||||
|
async def async_update(self) -> None:
|
||||||
|
"""Fetch updated power state from the server."""
|
||||||
|
try:
|
||||||
|
monitors = await self._client.get_display_monitors()
|
||||||
|
for monitor in monitors:
|
||||||
|
if monitor["id"] == self._monitor_id:
|
||||||
|
self._attr_is_on = monitor.get("power_on", True)
|
||||||
|
break
|
||||||
|
except MediaServerError as err:
|
||||||
|
_LOGGER.error("Failed to update power state for monitor %d: %s", self._monitor_id, err)
|
||||||
Reference in New Issue
Block a user