mirror of
https://github.com/basnijholt/adaptive-lighting.git
synced 2026-09-11 14:24:03 +02:00
f84ee445b7* refactor: introduce light control parameter enum * refactor: replace manual control flag with parameter enum * test: update deprecated color temp attribute * build: set execution bits on task scripts * feat: individual manual control of brightness and color * test: add tests for individual manual control evaluation * fix: sequential manual changes not always detected If multiple attributes of a light were changed within an interval, only the last change was detected because the check in the interval only used the latest event. For example, if there was a brightness change and a following color change, only the color attribute was detected as manually controlled. To fix this, the manual control attribute flags are now set directly from the event handler so that all events are processed. * fix: invalid service description * docs: fix missing space in config description * refactor: pluralize multivalued bitmask enum name
117 lines
3.6 KiB
Python
117 lines
3.6 KiB
Python
from typing import Any
|
|
|
|
import homeassistant.helpers.config_validation as cv
|
|
import pandas as pd
|
|
import voluptuous as vol
|
|
from homeassistant.helpers import selector
|
|
|
|
from .const import (
|
|
DOCS,
|
|
DOCS_APPLY,
|
|
DOCS_MANUAL_CONTROL,
|
|
SET_MANUAL_CONTROL_SCHEMA,
|
|
VALIDATION_TUPLES,
|
|
apply_service_schema,
|
|
)
|
|
|
|
|
|
def _format_voluptuous_instance(instance: vol.All) -> str:
|
|
coerce_type = None
|
|
min_val = None
|
|
max_val = None
|
|
|
|
for validator in instance.validators:
|
|
if isinstance(validator, vol.Coerce):
|
|
coerce_type = validator.type.__name__
|
|
elif isinstance(validator, vol.Clamp | vol.Range):
|
|
min_val = validator.min
|
|
max_val = validator.max
|
|
|
|
if min_val is not None and max_val is not None:
|
|
return f"`{coerce_type}` {min_val}-{max_val}"
|
|
if min_val is not None:
|
|
return f"`{coerce_type} > {min_val}`"
|
|
if max_val is not None:
|
|
return f"`{coerce_type} < {max_val}`"
|
|
return f"`{coerce_type}`"
|
|
|
|
|
|
def _type_to_str(type_: Any) -> str: # noqa: PLR0911
|
|
"""Convert a (voluptuous) type to a string."""
|
|
if type_ == cv.entity_ids:
|
|
return "list of `entity_id`s"
|
|
if type_ in (bool, int, float, str):
|
|
return f"`{type_.__name__}`"
|
|
if type_ == cv.boolean:
|
|
return "bool"
|
|
if isinstance(type_, vol.All):
|
|
return _format_voluptuous_instance(type_)
|
|
if isinstance(type_, vol.Any):
|
|
return " or ".join(_type_to_str(t) for t in type_.validators)
|
|
if isinstance(type_, vol.In):
|
|
return f"one of `{type_.container}`"
|
|
if isinstance(type_, selector.SelectSelector):
|
|
return f"one of `{type_.config['options']}`"
|
|
if isinstance(type_, selector.ColorRGBSelector):
|
|
return "RGB color"
|
|
msg = f"Unknown type: {type_}"
|
|
raise ValueError(msg)
|
|
|
|
|
|
def generate_config_markdown_table() -> str:
|
|
rows: list[dict[str, str]] = []
|
|
for k, default, type_ in VALIDATION_TUPLES:
|
|
description = DOCS[k]
|
|
row = {
|
|
"Variable name": f"`{k}`",
|
|
"Description": description,
|
|
"Default": f"`{default}`",
|
|
"Type": _type_to_str(type_),
|
|
}
|
|
rows.append(row)
|
|
|
|
df = pd.DataFrame(rows)
|
|
return df.to_markdown(index=False)
|
|
|
|
|
|
def _schema_to_dict(schema: vol.Schema) -> dict[str, tuple[Any, Any]]:
|
|
result: dict[str, tuple[Any, Any]] = {}
|
|
for key, value in schema.schema.items():
|
|
if isinstance(key, vol.Optional):
|
|
default_value = key.default
|
|
result[key.schema] = (default_value, value)
|
|
return result
|
|
|
|
|
|
def _generate_service_markdown_table(
|
|
schema: dict[str, tuple[Any, Any]] | vol.Schema,
|
|
alternative_docs: dict[str, str] | None = None,
|
|
) -> str:
|
|
schema_dict = _schema_to_dict(schema) if isinstance(schema, vol.Schema) else schema
|
|
rows: list[dict[str, str]] = []
|
|
for k, (default, type_) in schema_dict.items():
|
|
if alternative_docs is not None and k in alternative_docs:
|
|
description = alternative_docs[k]
|
|
else:
|
|
description = DOCS[k]
|
|
row = {
|
|
"Service data attribute": f"`{k}`",
|
|
"Description": description,
|
|
"Required": "✅" if default == vol.UNDEFINED else "❌",
|
|
"Type": _type_to_str(type_),
|
|
}
|
|
rows.append(row)
|
|
|
|
df = pd.DataFrame(rows)
|
|
return df.to_markdown(index=False)
|
|
|
|
|
|
def generate_apply_markdown_table() -> str:
|
|
return _generate_service_markdown_table(apply_service_schema(), DOCS_APPLY)
|
|
|
|
|
|
def generate_set_manual_control_markdown_table() -> str:
|
|
return _generate_service_markdown_table(
|
|
SET_MANUAL_CONTROL_SCHEMA,
|
|
DOCS_MANUAL_CONTROL,
|
|
)
|