http_request component (#719)

* It works * Template doesn't work * Template fix * CA Certificate untested * ESP32 done * URL validation * Lint fix * Lint fix (2) * Lint fix (<3) * Support unsecure requests with framework >=2.5.0 * Removed fingerprint, payload renamed to body * Removed add_extra * Review * Review * New HTTP methods * Check recommended version * Removed dead code * Small improvement * Small improvement * CONF_METHOD from const * JSON support * New JSON syntax * Templatable headers * verify_ssl param * verify_ssl param (fix) * Lint * nolint * JSON string_strict * Two json syntax * Lambda url fix validation * CI fix * CI fix
2026-05-19 04:33:27 +02:00 · 2019-11-09 20:37:52 +03:00
parent 3e8fd48dc0
commit f8d98ac494
6 changed files with 341 additions and 5 deletions
@@ -0,0 +1,148 @@
+import esphome.codegen as cg
+import esphome.config_validation as cv
+from esphome import automation
+from esphome.const import CONF_ID, CONF_TIMEOUT, CONF_ESPHOME, CONF_METHOD, \
+    CONF_ARDUINO_VERSION, ARDUINO_VERSION_ESP8266_2_5_0
+from esphome.core import CORE, Lambda
+from esphome.core_config import PLATFORMIO_ESP8266_LUT
+from esphome.py_compat import IS_PY3
+
+if IS_PY3:
+    import urllib.parse as urlparse  # pylint: disable=no-name-in-module,import-error
+else:
+    import urlparse  # pylint: disable=import-error
+
+DEPENDENCIES = ['network']
+AUTO_LOAD = ['json']
+
+http_request_ns = cg.esphome_ns.namespace('http_request')
+HttpRequestComponent = http_request_ns.class_('HttpRequestComponent', cg.Component)
+HttpRequestSendAction = http_request_ns.class_('HttpRequestSendAction', automation.Action)
+
+CONF_URL = 'url'
+CONF_HEADERS = 'headers'
+CONF_USERAGENT = 'useragent'
+CONF_BODY = 'body'
+CONF_JSON = 'json'
+CONF_VERIFY_SSL = 'verify_ssl'
+
+
+def validate_framework(config):
+    if CORE.is_esp32:
+        return config
+
+    version = 'RECOMMENDED'
+    if CONF_ARDUINO_VERSION in CORE.raw_config[CONF_ESPHOME]:
+        version = CORE.raw_config[CONF_ESPHOME][CONF_ARDUINO_VERSION]
+
+    if version in ['LATEST', 'DEV']:
+        return config
+
+    framework = PLATFORMIO_ESP8266_LUT[version] if version in PLATFORMIO_ESP8266_LUT else version
+    if framework < ARDUINO_VERSION_ESP8266_2_5_0:
+        raise cv.Invalid('This component is not supported on arduino framework version below 2.5.0')
+    return config
+
+
+def validate_url(value):
+    value = cv.string(value)
+    try:
+        parsed = list(urlparse.urlparse(value))
+    except Exception:
+        raise cv.Invalid('Invalid URL')
+
+    if not parsed[0] or not parsed[1]:
+        raise cv.Invalid('URL must have a URL scheme and host')
+
+    if parsed[0] not in ['http', 'https']:
+        raise cv.Invalid('Scheme must be http or https')
+
+    if not parsed[2]:
+        parsed[2] = '/'
+
+    return urlparse.urlunparse(parsed)
+
+
+def validate_secure_url(config):
+    url_ = config[CONF_URL]
+    if config.get(CONF_VERIFY_SSL) and not isinstance(url_, Lambda) \
+            and url_.lower().startswith('https:'):
+        raise cv.Invalid('Currently ESPHome doesn\'t support SSL verification. '
+                         'Set \'verify_ssl: false\' to make insecure HTTPS requests.')
+    return config
+
+
+CONFIG_SCHEMA = cv.Schema({
+    cv.GenerateID(): cv.declare_id(HttpRequestComponent),
+    cv.Optional(CONF_USERAGENT, 'ESPHome'): cv.string,
+    cv.Optional(CONF_TIMEOUT, default='5s'): cv.positive_time_period_milliseconds,
+}).add_extra(validate_framework).extend(cv.COMPONENT_SCHEMA)
+
+
+def to_code(config):
+    var = cg.new_Pvariable(config[CONF_ID])
+    cg.add(var.set_timeout(config[CONF_TIMEOUT]))
+    cg.add(var.set_useragent(config[CONF_USERAGENT]))
+    yield cg.register_component(var, config)
+
+
+HTTP_REQUEST_ACTION_SCHEMA = cv.Schema({
+    cv.GenerateID(): cv.use_id(HttpRequestComponent),
+    cv.Required(CONF_URL): cv.templatable(validate_url),
+    cv.Optional(CONF_HEADERS): cv.All(cv.Schema({cv.string: cv.templatable(cv.string)})),
+    cv.Optional(CONF_VERIFY_SSL, default=True): cv.boolean,
+}).add_extra(validate_secure_url)
+HTTP_REQUEST_GET_ACTION_SCHEMA = automation.maybe_conf(
+    CONF_URL, HTTP_REQUEST_ACTION_SCHEMA.extend({
+        cv.Optional(CONF_METHOD, default='GET'): cv.one_of('GET', upper=True),
+    })
+)
+HTTP_REQUEST_POST_ACTION_SCHEMA = automation.maybe_conf(
+    CONF_URL, HTTP_REQUEST_ACTION_SCHEMA.extend({
+        cv.Optional(CONF_METHOD, default='POST'): cv.one_of('POST', upper=True),
+        cv.Exclusive(CONF_BODY, 'body'): cv.templatable(cv.string),
+        cv.Exclusive(CONF_JSON, 'body'): cv.Any(
+            cv.lambda_, cv.All(cv.Schema({cv.string: cv.templatable(cv.string_strict)})),
+        ),
+    })
+)
+HTTP_REQUEST_SEND_ACTION_SCHEMA = HTTP_REQUEST_ACTION_SCHEMA.extend({
+    cv.Required(CONF_METHOD): cv.one_of('GET', 'POST', 'PUT', 'DELETE', 'PATCH', upper=True),
+    cv.Exclusive(CONF_BODY, 'body'): cv.templatable(cv.string),
+    cv.Exclusive(CONF_JSON, 'body'): cv.Any(
+        cv.lambda_, cv.All(cv.Schema({cv.string: cv.templatable(cv.string_strict)})),
+    ),
+})
+
+
+@automation.register_action('http_request.get', HttpRequestSendAction,
+                            HTTP_REQUEST_GET_ACTION_SCHEMA)
+@automation.register_action('http_request.post', HttpRequestSendAction,
+                            HTTP_REQUEST_POST_ACTION_SCHEMA)
+@automation.register_action('http_request.send', HttpRequestSendAction,
+                            HTTP_REQUEST_SEND_ACTION_SCHEMA)
+def http_request_action_to_code(config, action_id, template_arg, args):
+    paren = yield cg.get_variable(config[CONF_ID])
+    var = cg.new_Pvariable(action_id, template_arg, paren)
+
+    template_ = yield cg.templatable(config[CONF_URL], args, cg.const_char_ptr)
+    cg.add(var.set_url(template_))
+    cg.add(var.set_method(config[CONF_METHOD]))
+    if CONF_BODY in config:
+        template_ = yield cg.templatable(config[CONF_BODY], args, cg.std_string)
+        cg.add(var.set_body(template_))
+    if CONF_JSON in config:
+        json_ = config[CONF_JSON]
+        if isinstance(json_, Lambda):
+            args_ = args + [(cg.JsonObjectRef, 'root')]
+            lambda_ = yield cg.process_lambda(json_, args_, return_type=cg.void)
+            cg.add(var.set_json(lambda_))
+        else:
+            for key in json_:
+                template_ = yield cg.templatable(json_[key], args, cg.std_string)
+                cg.add(var.add_json(key, template_))
+    for key in config.get(CONF_HEADERS, []):
+        template_ = yield cg.templatable(config[CONF_HEADERS][key], args, cg.const_char_ptr)
+        cg.add(var.add_header(key, template_))
+
+    yield var