Basic Service Example

This is a simple “hello world” example to show the basics of registering a service. To use this example, create the file <config dir>/custom_components/ and copy the below example code.

Services can be called from automation and from the service “Developer tools” in the frontend.

# The domain of your component. Should be equal to the name of your component.
DOMAIN = 'hello_service'

ATTR_NAME = 'name'

def setup(hass, config):
    """Setup is called when Home Assistant is loading our component."""

    def handle_hello(call):
        name =, DEFAULT_NAME)

        hass.states.set('hello_service.hello', name), 'hello', handle_hello)

    # Return boolean to indicate that initialization was successfully.
    return True

Load the component by adding the following to your configuration.yaml. When your component is loaded, a new service should be available to call.

# configuration.yaml entry

Open the frontend and in the sidebar, click the first icon in the developer tool section. This will open the Call Service developer tool. On the right, find your service and click on it. This will automatically fill in the correct values.

Pressing “Call Service” will now call your service without any parameters. This will cause your service to create a state with the default name ‘World’. If you want to specify the name, you have to specify parameters. Add the following JSON as Service Data and press “Call Service again”.

  "name": "Planet"

The service will now overwrite the previous state with “Planet”.