Python Scripts

This component allows you to write Python scripts that are exposed as services in Home Assistant. Each Python file created in the <config>/python_scripts/ folder will be exposed as a service. The content is not cached so you can easily develop: edit file, save changes, call service. The scripts are run in a sandboxed environment. The following variables are available in the sandbox:

Name Description
hass The Home Assistant object. Access is only allowed to call services, set/remove states and fire events. API reference
data The data passed to the Python Script service call.
logger A logger to allow you to log messages:, logger.warning(), logger.error(). API reference

Writing your first script

  • Add to configuration.yaml: python_script:
  • Create folder <config>/python_scripts
  • Create a file in the folder and give it this content:
name = data.get('name', 'world')"Hello {}".format(name)), { "wow": "from a Python script!" })
  • Start Home Assistant
  • Call service python_script/hello_world with parameters
  "name": "you"

For python_script: examples visit the Scripts section in our forum.