jeans/core
1
0
Fork 0
mirror of https://github.com/home-assistant/core.git synced 2025-11-16 14:30:22 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add json_attributes_path configuration for command_line sensor (#116656)

Browse Source 
Add json attributes path config to command line sensor
This commit is contained in:
atlflyer
2024-07-06 12:52:27 -04:00
committed by GitHub
parent 490dd53edf
commit ec536bda3d
7 changed files with 74 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
homeassistant/components/command_line/sensor.py
View File

@@ -8,6 +8,8 @@ from datetime import datetime, timedelta
import json
from typing import Any, cast
from jsonpath import jsonpath
from homeassistant.components.sensor import SensorDeviceClass
from homeassistant.components.sensor.helpers import async_parse_date_datetime
from homeassistant.const import (
@@ -25,11 +27,15 @@ from homeassistant.helpers.trigger_template_entity import ManualTriggerSensorEnt
from homeassistant.helpers.typing import ConfigType, DiscoveryInfoType
from homeassistant.util import dt as dt_util
from .const import CONF_COMMAND_TIMEOUT, LOGGER, TRIGGER_ENTITY_OPTIONS
from .const import (
CONF_COMMAND_TIMEOUT,
CONF_JSON_ATTRIBUTES,
CONF_JSON_ATTRIBUTES_PATH,
LOGGER,
TRIGGER_ENTITY_OPTIONS,
)
from .utils import async_check_output_or_log
CONF_JSON_ATTRIBUTES = "json_attributes"
DEFAULT_NAME = "Command Sensor"
SCAN_INTERVAL = timedelta(seconds=60)
@@ -49,6 +55,7 @@ async def async_setup_platform(
command: str = sensor_config[CONF_COMMAND]
command_timeout: int = sensor_config[CONF_COMMAND_TIMEOUT]
json_attributes: list[str] | None = sensor_config.get(CONF_JSON_ATTRIBUTES)
json_attributes_path: str | None = sensor_config.get(CONF_JSON_ATTRIBUTES_PATH)
scan_interval: timedelta = sensor_config.get(CONF_SCAN_INTERVAL, SCAN_INTERVAL)
data = CommandSensorData(hass, command, command_timeout)
@@ -67,6 +74,7 @@ async def async_setup_platform(
trigger_entity_config,
value_template,
json_attributes,
json_attributes_path,
scan_interval,
)
]
@@ -84,6 +92,7 @@ class CommandSensor(ManualTriggerSensorEntity):
config: ConfigType,
value_template: Template | None,
json_attributes: list[str] | None,
json_attributes_path: str | None,
scan_interval: timedelta,
) -> None:
"""Initialize the sensor."""
@@ -91,6 +100,7 @@ class CommandSensor(ManualTriggerSensorEntity):
self.data = data
self._attr_extra_state_attributes: dict[str, Any] = {}
self._json_attributes = json_attributes
self._json_attributes_path = json_attributes_path
self._attr_native_value = None
self._value_template = value_template
self._scan_interval = scan_interval
@@ -141,6 +151,13 @@ class CommandSensor(ManualTriggerSensorEntity):
if value:
try:
json_dict = json.loads(value)
if self._json_attributes_path is not None:
json_dict = jsonpath(json_dict, self._json_attributes_path)
# jsonpath will always store the result in json_dict[0]
# so the next line happens to work exactly as needed to
# find the result
if isinstance(json_dict, list):
json_dict = json_dict[0]
if isinstance(json_dict, Mapping):
self._attr_extra_state_attributes = {
k: json_dict[k]