James Mackay
c3e4c7855c
One optional 'Remote command script' on the Configure page. Configured, it replaces
the whole key path for remote.send_command; unset, repeats, long presses and delays go
out as protocol keys exactly as before (the existing send_command tests pass
untouched).
A remote command is a SEQUENCE — repeats, a START_LONG/END_LONG pair, an inter-repeat
delay — so the escape hatch is one script for the call rather than per-key overrides:
an IR bridge, a macro, or a second device needs the call, not individual keys. The
script receives the service's own parameters as variables, named as they are on the
service and documented in the README and pinned in tests:
command the list of key commands as submitted (e.g. ["HOME", "KEYCODE_DPAD_CENTER"])
num_repeats the repeat count (default 1)
delay_secs the inter-repeat delay (default 0.0)
hold_secs the long-press duration, START_LONG/END_LONG handled by the script
(default 0.0) — the script owns the key semantics, so it decides what
"hold" means
All four are always present, including defaults, so a script can rely on the shape.
A raising script surfaces a translated error rather than a silent no-op. That made the
t44 script-failure mechanism consistent in the process: async_call_script() is now the
one caller for both the media player's per-command scripts and the remote's, raising
ServiceValidationError(translation_domain="nvidia_shield",
translation_key="command_script_failed") with {action, script, error} placeholders
instead of a bare HomeAssistantError — the t44 test was updated to assert the
translation contract (domain, key, placeholders) rather than a message string, which is
stronger evidence and gives the user real copy. The new copy lives in BOTH strings
files, as does the unknown_source key from UNIT A.
Option handling reuses the t47 C work: the field is an entity selector (so a cleared
value is tolerated by the schema), the stored value is trimmed, and a blank,
hand-edited or non-string value means "not configured" rather than a call to nowhere.
Verified: 454 passed / 2 skipped, ruff clean, drift engine exit 0 under real HA
(23 modules, 58 imports, 164 relative imports, 36 call arguments, 7 awaited HA calls).
232 lines
8.9 KiB
Python
232 lines
8.9 KiB
Python
"""Constants for the Nvidia Shield integration."""
|
|
|
|
# Re-export shared Media DAG constants
|
|
from .ha_adb_common.const import ( # noqa: F401
|
|
ATTR_MEDIA_DAG_JELLYFIN_ENTITY,
|
|
ATTR_MEDIA_DAG_NOW_PLAYING,
|
|
ATTR_MEDIA_DAG_RECEIVER_ENTITY,
|
|
ATTR_MEDIA_DAG_RECEIVER_INPUT,
|
|
ATTR_MEDIA_DAG_ROLE,
|
|
ATTR_MEDIA_DAG_RUNNING_APPS,
|
|
)
|
|
|
|
DOMAIN = "nvidia_shield"
|
|
|
|
# t41: the INTEGRATION's address field — one Shield IP for the whole stack
|
|
# (protocol + ADB). The two keys below it are LEGACY: a YAML seed may still
|
|
# carry them and the v3 entry migration maps them onto CONF_HOST, but no
|
|
# runtime code reads them.
|
|
CONF_HOST = "host"
|
|
CONF_ADB_HOST = "adb_host"
|
|
CONF_PROTOCOL_HOST = "protocol_host"
|
|
|
|
# t41 legacy: dropped from entries by the v3 migration (the androidtv entity
|
|
# path it configured is gone), never read at runtime.
|
|
CONF_ANDROIDTV_ENTITY = "androidtv_entity"
|
|
CONF_JELLYFIN_ENTITY = "jellyfin_entity"
|
|
CONF_RECEIVER_ENTITY = "receiver_entity"
|
|
CONF_RECEIVER_INPUT = "receiver_input"
|
|
CONF_POWER_ENTITY = "power_entity"
|
|
CONF_ADB_ENABLED = "adb_enabled"
|
|
CONF_ADB_STORE_APP_INFO = "adb_store_app_info"
|
|
CONF_ADB_PORT = "adb_port"
|
|
|
|
# Remote-protocol transport (androidtvremote2) — Phase 2
|
|
CONF_PROTOCOL_ENABLED = "protocol_enabled"
|
|
CONF_PAIRING_CODE = "pairing_code"
|
|
# t33 F-B: the "continue without pairing" escape offered on BOTH pairing
|
|
# steps — the entry still finishes (passive mode) instead of stranding the
|
|
# user on a form with no way forward.
|
|
CONF_SKIP_PAIRING = "skip_pairing"
|
|
DEFAULT_PROTOCOL_API_PORT = 6466
|
|
DEFAULT_PROTOCOL_PAIR_PORT = 6467
|
|
|
|
ADB_POLL_INTERVAL = 10 # seconds
|
|
ADB_RETRY_INTERVAL = 300 # seconds before retrying a failed ADB connection
|
|
DEFAULT_ADB_PORT = 5555
|
|
|
|
# Persistent-connection manager timing (Phase 1, docs/MVP_PLAN.md §2):
|
|
# watchdog reconnects with exponential backoff + jitter; ADB-derived store
|
|
# fields expire (B5) instead of clinging to stale values.
|
|
ADB_RECONNECT_BACKOFF_START = 5 # seconds before the first reconnect retry
|
|
ADB_RECONNECT_BACKOFF_CAP = 300 # seconds; backoff never sleeps longer
|
|
ADB_RECONNECT_JITTER = 0.25 # ±25 % randomization against reconnect storms
|
|
STATE_STORE_TTL = 60 # ADB-sourced fields older than this are stale
|
|
|
|
DEFAULT_NAME = "Nvidia Shield"
|
|
|
|
# Config-entry schema version (t41): v1 → v2 added the remote-protocol fields,
|
|
# v2 → v3 collapsed the two address fields into CONF_HOST and dropped the
|
|
# androidtv-entity key. One constant so the flow and the migration cannot drift.
|
|
ENTRY_VERSION = 3
|
|
|
|
# Emotiva DAG attribute we read to get available inputs
|
|
ATTR_MEDIA_DAG_INPUT_MAP = "media_dag_input_map"
|
|
|
|
# Known Jellyfin app package IDs (used to route Jellyfin-family clients
|
|
# — including Wholphin, a Jellyfin client — to the rich-metadata path).
|
|
JELLYFIN_APP_IDS = [
|
|
"org.jellyfin.androidtv",
|
|
"org.jellyfin.mobile",
|
|
"com.github.damontecres.wholphin",
|
|
]
|
|
|
|
# Remote-protocol key names (RemoteKeyCode enum in remotemessage.proto).
|
|
# HA service kind → protocol keycode string.
|
|
PROTOCOL_MEDIA_KEYS = {
|
|
"media_play": "KEYCODE_MEDIA_PLAY",
|
|
"media_pause": "KEYCODE_MEDIA_PAUSE",
|
|
"media_stop": "KEYCODE_MEDIA_STOP",
|
|
"media_next_track": "KEYCODE_MEDIA_NEXT",
|
|
"media_previous_track": "KEYCODE_MEDIA_PREVIOUS",
|
|
}
|
|
PROTOCOL_VOLUME_KEYS = {
|
|
"volume_up": "KEYCODE_VOLUME_UP",
|
|
"volume_down": "KEYCODE_VOLUME_DOWN",
|
|
"volume_mute": "KEYCODE_VOLUME_MUTE",
|
|
}
|
|
PROTOCOL_REMOTE_KEYS = {
|
|
**PROTOCOL_VOLUME_KEYS,
|
|
"play": "KEYCODE_MEDIA_PLAY",
|
|
"pause": "KEYCODE_MEDIA_PAUSE",
|
|
"stop": "KEYCODE_MEDIA_STOP",
|
|
"up": "KEYCODE_DPAD_UP",
|
|
"down": "KEYCODE_DPAD_DOWN",
|
|
"left": "KEYCODE_DPAD_LEFT",
|
|
"right": "KEYCODE_DPAD_RIGHT",
|
|
"enter": "KEYCODE_DPAD_CENTER",
|
|
"home": "KEYCODE_HOME",
|
|
"back": "KEYCODE_BACK",
|
|
"menu": "KEYCODE_MENU",
|
|
"search": "KEYCODE_SEARCH",
|
|
"power": "KEYCODE_POWER",
|
|
"channel_up": "KEYCODE_CHANNEL_UP",
|
|
"channel_down": "KEYCODE_CHANNEL_DOWN",
|
|
}
|
|
|
|
# §7 channel selection: digits only, ~0.1 s apart, no ENTER by default
|
|
# (replicates HA core androidtv_remote's verified behavior).
|
|
# Zeroconf discovery (Phase 4): the Android TV remote service type.
|
|
ZEROCONF_SERVICE_TYPE = "_androidtvremote2._tcp.local."
|
|
|
|
# P4-1 apps name/icon map (options flow editor): package → friendly name,
|
|
# consumed by app_name after the androidtv-entity and protocol-push tiers.
|
|
CONF_APP_NAME_MAP = "app_name_map"
|
|
|
|
# P5-2: optional icon column (package|icon) — package → icon URL, feeding
|
|
# entity_picture when no Jellyfin session picture is live.
|
|
CONF_APP_ICON_MAP = "app_icon_map"
|
|
|
|
# P5-1: device manifest label cache TTL (long — labels change with app
|
|
# updates, not per poll).
|
|
APP_LABEL_TTL = 24 * 3600
|
|
|
|
# P4-2a adb_command service: rawADB shell on this entry — OFF by default
|
|
# (same security posture as the core androidtv integration).
|
|
CONF_ADB_COMMAND_ENABLED = "adb_command_enabled"
|
|
SERVICE_ADB_COMMAND = "adb_command"
|
|
|
|
# P5-3 (C-STREAM): live events push — the streaming_shell logcat consumer
|
|
# (foreground AppState fast-path). Default OFF; the user flips it on and
|
|
# reports stability on their device.
|
|
CONF_LOGCAT_EVENTS = "logcat_events"
|
|
|
|
# P5-3: duplicate START for the same package inside this window is not
|
|
# re-stamped (repeat suppression).
|
|
LOGCAT_SUPPRESS_WINDOW = 15.0
|
|
|
|
# P4-2c BrowseMedia app directory fallback when the options map is empty
|
|
# (curated; the packages are the plan's reference apps).
|
|
DEFAULT_APP_DIRECTORY = {
|
|
"ar.tvplayer.tv": "TiviMate",
|
|
"com.github.damontecres.wholphin": "Wholphin",
|
|
"com.netflix.ninja": "Netflix",
|
|
"com.google.android.youtube.tv": "YouTube",
|
|
}
|
|
|
|
CHANNEL_DIGIT_DELAY = 0.1
|
|
CONF_CHANNEL_DIGIT_DELAY = "channel_digit_delay"
|
|
CONF_CHANNEL_SEND_ENTER = "channel_send_enter"
|
|
|
|
# Verified on-device package names (docs/RESEARCH_SHIELD.md): TiviMate does
|
|
# not publish a MediaSession on Shield Android 11 — it is the headline
|
|
# Phase-3 fallback app.
|
|
TIVIMATE_PACKAGE = "ar.tvplayer.tv"
|
|
|
|
# Packages to ignore when parsing foreground/audio-playback identities
|
|
SYSTEM_MEDIA_PACKAGES = [
|
|
"com.google.android.apps.mediashell", # Chromecast receiver process
|
|
"com.android.systemui",
|
|
"com.android.tv.settings",
|
|
"com.nvidia.diagtools",
|
|
]
|
|
|
|
|
|
# t44: per-command script overrides — the escape hatch for hardware this
|
|
# integration deliberately does not drive itself (a speaker switch that owns the
|
|
# volume, an AVR input, a mute that has to hit two devices). One script per
|
|
# command: when one is configured, that command calls the script INSTEAD of the
|
|
# native protocol/ADB path, and with none configured nothing changes at all.
|
|
CONF_COMMAND_SCRIPTS = "command_scripts"
|
|
SCRIPT_COMMANDS = (
|
|
"turn_on",
|
|
"turn_off",
|
|
"volume_up",
|
|
"volume_down",
|
|
"volume_set",
|
|
"volume_mute",
|
|
"select_source",
|
|
)
|
|
#: Options-flow field name per command: ``script_turn_on``, ``script_volume_set``…
|
|
SCRIPT_FIELD_PREFIX = "script_"
|
|
#: Variables a command hands its script (HA script variables). volume_mute passes
|
|
#: whether it is muting or unmuting — a script cannot tell those apart otherwise.
|
|
SCRIPT_VAR_LEVEL = "level"
|
|
SCRIPT_VAR_APP_NAME = "app_name"
|
|
SCRIPT_VAR_MUTED = "is_volume_muted"
|
|
|
|
|
|
def command_scripts(options) -> dict[str, str]:
|
|
"""The script configured per command, normalized (t44).
|
|
|
|
The ONE place the stored option's shape is read: the options flow, the media
|
|
player and the remote entity all go through it. Options round-trip through HA
|
|
storage and can be hand-edited, so a value that is not a non-empty string for a
|
|
known command is dropped rather than handed to the service layer.
|
|
"""
|
|
raw = (options or {}).get(CONF_COMMAND_SCRIPTS)
|
|
if not isinstance(raw, dict):
|
|
return {}
|
|
scripts: dict[str, str] = {}
|
|
for command in SCRIPT_COMMANDS:
|
|
script = raw.get(command)
|
|
if isinstance(script, str) and script.strip():
|
|
scripts[command] = script.strip()
|
|
return scripts
|
|
|
|
|
|
# t47: ONE optional script for the remote entity's send_command. It replaces the
|
|
# whole key path (repeats, hold, delays included) rather than per-key overrides,
|
|
# because a remote command is a sequence: an IR bridge, a macro or a second device
|
|
# needs the call, not individual keys.
|
|
CONF_REMOTE_COMMAND_SCRIPT = "remote_command_script"
|
|
#: Variables remote.send_command hands its script — the names are the service's own
|
|
#: parameter names, and they are documented in the README and pinned in tests.
|
|
SCRIPT_VAR_COMMAND = "command"
|
|
SCRIPT_VAR_NUM_REPEATS = "num_repeats"
|
|
SCRIPT_VAR_DELAY_SECS = "delay_secs"
|
|
SCRIPT_VAR_HOLD_SECS = "hold_secs"
|
|
|
|
|
|
def remote_command_script(options) -> str | None:
|
|
"""The script configured for remote.send_command, or None (t47).
|
|
|
|
Same defensive read as ``command_scripts``: options round-trip through HA
|
|
storage and can be hand-edited, so anything that is not a non-empty string is
|
|
"not configured" rather than a service call to nowhere.
|
|
"""
|
|
script = (options or {}).get(CONF_REMOTE_COMMAND_SCRIPT)
|
|
if isinstance(script, str) and script.strip():
|
|
return script.strip()
|
|
return None
|