Config Validation

import homeassistant.helpers.config_validation as cv

result = cv.boolean("yes")  # Returns: True
result = cv.boolean("0")    # Returns: False
result = cv.boolean(1)      # Returns: True

result = cv.string("hello")  # Returns: "hello"
result = cv.string(123)      # Returns: "123"
# cv.string(None)  # Raises vol.Invalid

result = cv.entity_id("Light.Living_Room")  # Returns: "light.living_room"

result = cv.entity_ids("light.living_room, light.bedroom")
# Returns: ["light.living_room", "light.bedroom"]

result = cv.entity_ids(["light.living_room", "light.bedroom"])
# Returns: ["light.living_room", "light.bedroom"]

validate_light = cv.entity_domain("light")
result = validate_light("light.living_room")  # Returns: "light.living_room"
# validate_light("switch.outlet")  # Raises vol.Invalid

result = cv.service("light.turn_on")  # Returns: "light.turn_on"

positive_int = vol.All(vol.Coerce(int), vol.Range(min=0))

positive_float = vol.All(vol.Coerce(float), vol.Range(min=0))

port = vol.All(vol.Coerce(int), vol.Range(min=1, max=65535))

byte = vol.All(vol.Coerce(int), vol.Range(min=0, max=255))

latitude = vol.All(
    vol.Coerce(float),
    vol.Range(min=-90, max=90),
    msg="invalid latitude"
)

longitude = vol.All(
    vol.Coerce(float),
    vol.Range(min=-180, max=180),
    msg="invalid longitude"
)

gps = vol.ExactSequence([latitude, longitude])

result = cv.gps([51.5074, -0.1278])  # Valid

result = cv.time("14:30:00")  # Returns: time(14, 30, 0)

result = cv.time_period("00:05:00")  # Returns: timedelta(minutes=5)
result = cv.time_period(300)         # Returns: timedelta(seconds=300)
result = cv.time_period({"minutes": 5})  # Returns: timedelta(minutes=5)

positive_time_period = vol.All(time_period, positive_timedelta)

result = cv.template("{{ states('sensor.temperature') }}")

result = cv.dynamic_template("{{ now() }}")
# cv.dynamic_template("static")  # Raises vol.Invalid

result = cv.url("https://example.com")  # Valid
result = cv.url("http://example.com")   # Valid

result = cv.configuration_url("homeassistant://navigate/lovelace/dashboard")
result = cv.configuration_url("https://example.com")

result = cv.path("/config/custom_components")  # Valid path

result = cv.isfile("/config/configuration.yaml")  # Valid if file exists

result = cv.isdir("/config")  # Valid if directory exists

schema = vol.Schema(
    vol.All(
        {
            vol.Optional("name"): str,
            vol.Optional("id"): int,
        },
        cv.has_at_least_one_key("name", "id")
    )
)

schema = vol.Schema(
    vol.All(
        {
            vol.Optional("action"): str,
            vol.Optional("service"): str,
        },
        cv.has_at_most_one_key("action", "service")
    )
)

schema = vol.Schema(
    vol.All(
        {
            vol.Optional("name"): str,
        },
        cv.deprecated("entity_namespace", replacement_key="name")
    )
)

SERVICE_TURN_ON_SCHEMA = cv.make_entity_service_schema(
    {
        vol.Optional("brightness"): vol.All(vol.Coerce(int), vol.Range(0, 255)),
        vol.Optional("color_temp"): vol.All(vol.Coerce(int), vol.Range(153, 500)),
    }
)

PLATFORM_SCHEMA = cv.PLATFORM_SCHEMA_BASE.extend({
    vol.Required("api_key"): cv.string,
    vol.Optional("scan_interval"): cv.positive_time_period,
})