List of available actions
Actions are the things Home Assistant can do for you, like turning a light on, setting a thermostat, playing music, or restarting the system. They are the building blocks of automations and scripts.
Browse the full list below, or use the search box to find a specific action by name or description. Each action has its own page with a step-by-step UI walkthrough, examples, and a complete data field reference.
New to actions? Read about actions in automations and scripts to learn how they fit together.
Abode
-
Capture image
abode.capture_imageRequests a new still image from an Abode camera. -
Change setting
abode.change_settingChanges a setting on your Abode system. -
Trigger automation
abode.trigger_automationTriggers an automation on your Abode system.
AdGuard Home
-
Add URL
adguard.add_urlAdds a new filter subscription to AdGuard Home. -
Disable URL
adguard.disable_urlDisables a filter subscription in AdGuard Home. -
Enable URL
adguard.enable_urlEnables a filter subscription in AdGuard Home. -
Refresh
adguard.refreshRefreshes all filter subscriptions in AdGuard Home. -
Remove URL
adguard.remove_urlRemoves a filter subscription from AdGuard Home.
ADS
-
Write data by name
ads.write_data_by_nameWrites a value to a variable on a connected ADS device.
AfterShip
-
Add tracking
aftership.add_trackingAdds a new tracking number to AfterShip. -
Remove tracking
aftership.remove_trackingRemoves a tracking number from AfterShip.
Agent DVR
-
Disable alerts
agent_dvr.disable_alertsDisables alert events for an Agent DVR camera. -
Enable alerts
agent_dvr.enable_alertsEnables alert events for an Agent DVR camera. -
Snapshot
agent_dvr.snapshotTakes a photo on an Agent DVR camera. -
Start recording
agent_dvr.start_recordingStarts continuous recording on an Agent DVR camera. -
Stop recording
agent_dvr.stop_recordingStops continuous recording on an Agent DVR camera.
AI Task
-
Generate data
ai_task.generate_dataUses AI to run a task that generates data, such as text or structured output. -
Generate image
ai_task.generate_imageUses AI to generate an image from a set of instructions.
Alarm control panel
-
Arm alarm away
alarm_control_panel.alarm_arm_awayArm an alarm control panel in away mode. Optionally provide a code if your alarm panel requires one. -
Arm alarm with custom bypass
alarm_control_panel.alarm_arm_custom_bypassArm an alarm control panel while bypassing specific zones. Optionally provide a code if your alarm panel requires one. -
Arm alarm home
alarm_control_panel.alarm_arm_homeArm an alarm control panel in home mode. Optionally provide a code if your alarm panel requires one. -
Arm alarm night
alarm_control_panel.alarm_arm_nightArm an alarm control panel in night mode. Optionally provide a code if your alarm panel requires one. -
Arm alarm vacation
alarm_control_panel.alarm_arm_vacationArm an alarm control panel in vacation mode. Optionally provide a code if your alarm panel requires one. -
Disarm alarm
alarm_control_panel.alarm_disarmDisarm an alarm control panel. Optionally provide a code if your alarm panel requires one. -
Trigger alarm
alarm_control_panel.alarm_triggerManually trigger an alarm control panel. Optionally provide a code if your alarm panel requires one.
AlarmDecoder
-
Key press
alarmdecoder.alarm_keypressSends custom key presses to an AlarmDecoder alarm panel. -
Toggle chime
alarmdecoder.alarm_toggle_chimeToggles the chime on an AlarmDecoder alarm panel.
Amber Electric
-
Get price forecasts
amberelectric.get_forecastsRetrieves price forecasts from Amber Electric for a site and channel.
Apple TV
-
Append keyboard text
apple_tv.append_keyboard_textAppends text to the currently focused text input field on an Apple TV. -
Clear keyboard text
apple_tv.clear_keyboard_textClears the text in the currently focused text input field on an Apple TV. -
Set keyboard text
apple_tv.set_keyboard_textSets the text in the currently focused text input field on an Apple TV.
Assist Satellite
-
Announce on satellite
assist_satellite.announceAnnounces a message on an Assist satellite. -
Ask question on satellite
assist_satellite.ask_questionAsks a question on an Assist satellite and gets the response. -
Start conversation on satellite
assist_satellite.start_conversationStarts a conversation from an Assist satellite.
Backup
-
Create backup
backup.createCreates a basic local backup of your Home Assistant instance. -
Create automatic backup
backup.create_automaticCreates a backup using your configured automatic backup settings.
Bang & Olufsen
-
Beolink all standby
bang_olufsen.beolink_allstandbySets all connected Beolink devices to standby. -
Beolink expand
bang_olufsen.beolink_expandAdds devices to the current Beolink experience. -
Beolink join
bang_olufsen.beolink_joinJoins a Beolink experience. -
Beolink leave
bang_olufsen.beolink_leaveLeaves a Beolink experience. -
Beolink unexpand
bang_olufsen.beolink_unexpandRemoves devices from the current Beolink experience.
Blink
-
Record
blink.recordRequests a Blink camera to record a new video clip. -
Save recent clips
blink.save_recent_clipsSaves all recent video clips of a Blink camera to a local directory. -
Save video
blink.save_videoSaves the last recorded video clip of a Blink camera to a local file. -
Trigger camera
blink.trigger_cameraRequests a Blink camera to take a new image.
Bring!
-
Send message
bring.send_messageSends a push notification to members of a shared Bring! list. -
Send reaction
bring.send_reactionSends an emoji reaction to a recent activity on a Bring! list.
Browser
-
Browse URL
browser.browse_urlOpens a URL in the default browser on the machine running Home Assistant.
BSB-LAN
-
Set hot water schedule
bsblan.set_hot_water_scheduleSets the hot water heating schedule for a BSB-LAN device. -
Sync time
bsblan.sync_timeSynchronizes the Home Assistant time to a BSB-LAN device.
Button
-
Press button
button.pressPresses a button entity.
Calendar
-
Create calendar event
calendar.create_eventAdds a new event to a calendar. -
Get calendar events
calendar.get_eventsGets the events on a calendar within a date range.
Camera
-
Disable camera motion detection
camera.disable_motion_detectionDisables the motion detection of a camera. -
Enable camera motion detection
camera.enable_motion_detectionEnables the motion detection of a camera. -
Play camera stream
camera.play_streamPlays a camera stream on a supported media player. -
Record camera feed
camera.recordCreates a recording of a live camera feed. -
Take camera snapshot
camera.snapshotTakes a snapshot from a camera. -
Turn off camera
camera.turn_offTurns off a camera. -
Turn on camera
camera.turn_onTurns on a camera.
Climate
-
Set thermostat fan mode
climate.set_fan_modeSets the fan mode of a climate device. -
Set thermostat target humidity
climate.set_humiditySets the target humidity of a climate device. -
Set thermostat HVAC mode
climate.set_hvac_modeSets the HVAC mode of a climate device. -
Set thermostat preset mode
climate.set_preset_modeSets the preset mode of a climate device. -
Set thermostat horizontal swing mode
climate.set_swing_horizontal_modeSets the horizontal swing mode of a climate device. -
Set thermostat swing mode
climate.set_swing_modeSets the swing mode of a climate device. -
Set thermostat target temperature
climate.set_temperatureSets the target temperature of a climate device. -
Toggle thermostat
climate.toggleToggles a climate device on or off. -
Turn off thermostat
climate.turn_offTurns off a climate device. -
Turn on thermostat
climate.turn_onTurns on a climate device.
ColorExtractor
-
Get predominant color
color_extractor.get_colorReturns the predominant RGB color found in an image provided by URL or file path. -
Turn on
color_extractor.turn_onSets a light to the predominant color found in an image provided by URL or file path.
Conversation
-
Process conversation
conversation.processSends text to a conversation agent for processing. -
Reload conversation agents
conversation.reloadReloads the intent configuration of conversation agents.
Counter
-
Decrement counter
counter.decrementDecreases a counter by its step size. -
Increment counter
counter.incrementIncreases a counter by its step size. -
Reset counter
counter.resetResets a counter to its initial value. -
Set counter value
counter.set_valueSets a counter to a specific value.
Cover
-
Close cover
cover.close_coverCloses a cover. -
Close cover tilt
cover.close_cover_tiltTilts a cover closed. -
Open cover
cover.open_coverOpens a cover. -
Open cover tilt
cover.open_cover_tiltTilts a cover open. -
Set cover position
cover.set_cover_positionMoves a cover to a specific position. -
Set cover tilt position
cover.set_cover_tilt_positionTilts a cover to a specific position. -
Stop cover
cover.stop_coverStops the movement of a cover. -
Stop cover tilt
cover.stop_cover_tiltStops the tilting of a cover. -
Toggle cover
cover.toggleToggles a cover open or closed. -
Toggle cover tilt
cover.toggle_cover_tiltToggles a cover tilt open or closed.
Date
-
Set date value
date.set_valueSets the value of a date entity.
Date/Time
-
Set date/time value
datetime.set_valueSets the value of a date/time entity.
Remote Python Debugger
-
Start the remote Python debugger
debugpy.startInject and start the remote Python debugger at runtime.
deCONZ
-
Configure
deconz.configureSet an attribute of a device endpoint in deCONZ or of the deCONZ service itself. -
Device refresh
deconz.device_refreshRefresh the list of available devices from deCONZ. -
Remove orphaned entries
deconz.remove_orphaned_entriesClean up device and entity registry entries that deCONZ no longer provides.
Denon AVR Network Receivers
-
Get command
denonavr.get_commandSend a generic HTTP command to a Denon AVR receiver over the network. -
Set dynamic equalizer
denonavr.set_dynamic_eqEnable or disable the DynamicEQ setting on a Denon AVR receiver. -
Update Audyssey
denonavr.update_audysseyUpdate the Audyssey settings on a Denon AVR receiver.
Duck DNS
-
Set TXT
duckdns.set_txtSets the TXT record of your Duck DNS subdomain.
Philips Dynalite
-
Request area preset
dynalite.request_area_presetAsks a Dynalite area to report its currently selected preset. -
Request channel level
dynalite.request_channel_levelAsks a Dynalite channel to report its current level.
easyEnergy
-
Get energy return prices
easyenergy.get_energy_return_pricesRequests energy return prices from easyEnergy. -
Get energy usage prices
easyenergy.get_energy_usage_pricesRequests energy usage prices from easyEnergy. -
Get gas prices
easyenergy.get_gas_pricesRequests gas prices from easyEnergy.
Elgato Light
-
Identify a light
elgato.identifyBriefly blinks an Elgato Light to identify it or as a visual notification.
EnergyZero
-
Get energy prices
energyzero.get_energy_pricesRequests energy prices from EnergyZero. -
Get gas prices
energyzero.get_gas_pricesRequests gas prices from EnergyZero.
Environment Canada
-
Get alerts
environment_canada.get_alertsRetrieves the active weather alerts for an Environment Canada location. -
Get forecasts
environment_canada.get_forecastsRetrieves the raw daily and hourly forecast data from Environment Canada. -
Set radar type
environment_canada.set_radar_typeSets the type of radar imagery shown by an Environment Canada radar camera.
Envisalink
-
Alarm keypress
envisalink.alarm_keypressSends custom keypresses to an Envisalink alarm panel. -
Invoke custom function
envisalink.invoke_custom_functionTriggers a PGM output on a DSC alarm panel.
Fan
-
Decrease fan speed
fan.decrease_speedDecrease the speed of a fan. -
Increase fan speed
fan.increase_speedIncrease the speed of a fan. -
Oscillate fan
fan.oscillateControl the oscillation of a fan. -
Set fan direction
fan.set_directionSet a fan's rotation direction. -
Set fan speed
fan.set_percentageSet the speed of a fan. -
Set fan preset mode
fan.set_preset_modeSet the preset mode of a fan. -
Toggle fan
fan.toggleToggle a fan on or off. -
Turn off fan
fan.turn_offTurn off a fan. -
Turn on fan
fan.turn_onTurn on a fan. Optionally set the speed or preset mode at the same time.
File
-
Read file
file.read_fileReads a file and returns its contents in a response.
Flo
-
Run health test
flo.run_health_testRuns a health test on a Flo by Moen device. -
Set away mode
flo.set_away_modePuts a Flo by Moen device into away mode. -
Set home mode
flo.set_home_modePuts a Flo by Moen device into home mode. -
Set sleep mode
flo.set_sleep_modePuts a Flo by Moen device into sleep mode for a set duration.
Home Assistant frontend
-
Reload themes
frontend.reload_themesReloads the theme configuration from your configuration.yaml file. -
Set theme
frontend.set_themeSets the theme Home Assistant uses by default.
Google Calendar
-
Create event in Google Calendar
google.create_eventAdds a new event to a calendar in Google Calendar.
Google Photos
-
Upload
google_photos.uploadUploads one or more photos or videos from Home Assistant to Google Photos.
Google Sheets
-
Append sheet
google_sheets.append_sheetAdds rows of data to a Google Sheets document. -
Get sheet
google_sheets.get_sheetRetrieves rows of data from a Google Sheets document.
Google Maps Travel Time
-
Get transit times
google_travel_time.get_transit_timesRetrieves route alternatives and travel times between two locations using public transit. -
Get travel times
google_travel_time.get_travel_timesRetrieves route alternatives and travel times between two locations.
Group
-
Reload groups
group.reloadReloads the groups from the YAML configuration. -
Remove group
group.removeRemoves an old-style group. -
Set group
group.setCreates or updates an old-style group.
Habitica
-
Abort an active quest
habitica.abort_questTerminates your Habitica party's ongoing quest and resets all progress. -
Accept a quest invitation
habitica.accept_questAccepts a pending quest invitation for your Habitica party. -
Cancel a pending quest
habitica.cancel_questCancels a Habitica quest that has not started yet and resets invitations. -
Cast a skill
habitica.cast_skillUses a skill or spell from your Habitica character on a task. -
Create a daily
habitica.create_dailyCreates a daily for your Habitica character. -
Create habit
habitica.create_habitCreates a habit for your Habitica character. -
Create reward
habitica.create_rewardCreates a custom reward for your Habitica character. -
Create to-do
habitica.create_todoCreates a to-do for your Habitica character. -
Get tasks
habitica.get_tasksRetrieves tasks from your Habitica account, with optional filters. -
Leave a quest
habitica.leave_questLeaves the quest your Habitica character is participating in. -
Reject a quest invitation
habitica.reject_questRejects a pending quest invitation for your Habitica character. -
Track a habit
habitica.score_habitIncreases the positive or negative streak of a Habitica habit to track its progress. -
Buy a reward
habitica.score_rewardBuys a custom Habitica reward with gold. -
Force-start a pending quest
habitica.start_questForce-starts your Habitica party's quest, bypassing pending invitations. -
Use a transformation item
habitica.transformationUses a transformation item on a Habitica party member or yourself. -
Update a daily
habitica.update_dailyUpdates an existing daily for your Habitica character. -
Update a habit
habitica.update_habitUpdates an existing habit for your Habitica character. -
Update a reward
habitica.update_rewardUpdates an existing custom reward for your Habitica character. -
Update a to-do
habitica.update_todoUpdates an existing to-do for your Habitica character.
Home Assistant Supervisor
-
Restart app
hassio.app_restartRestarts a Home Assistant app. -
Start app
hassio.app_startStarts a Home Assistant app. -
Write data to app stdin
hassio.app_stdinWrites data to the standard input of a Home Assistant app. -
Stop app
hassio.app_stopStops a Home Assistant app. -
Create a full backup
hassio.backup_fullCreates a full backup. -
Create a partial backup
hassio.backup_partialCreates a partial backup. -
Reboot the host system
hassio.host_rebootReboots the host system. -
Power off the host system
hassio.host_shutdownPowers off the host system. -
Reload network storage mount
hassio.mount_reloadReloads a network storage mount. -
Restore from full backup
hassio.restore_fullRestores from a full backup. -
Restore from partial backup
hassio.restore_partialRestores from a partial backup.
HDMI-CEC
-
Power on
hdmi_cec.power_onPowers on all devices on the HDMI-CEC bus that support this function. -
Select device
hdmi_cec.select_deviceMakes an HDMI-CEC device the active source. -
Send command
hdmi_cec.send_commandSends a raw CEC command to the HDMI-CEC bus. -
Standby
hdmi_cec.standbyPuts all devices on the HDMI-CEC bus that support this function into standby. -
Update
hdmi_cec.updateUpdates the state of HDMI-CEC devices from the bus. -
Volume
hdmi_cec.volumeChanges the volume or mute state of the HDMI-CEC audio system.
Denon HEOS
-
Get queue
heos.get_queueRetrieves the play queue of a HEOS media player. -
Turn down group volume
heos.group_volume_downTurns down the volume of a HEOS group a step. -
Set group volume
heos.group_volume_setSets the volume of a HEOS group while preserving member volume ratios. -
Turn up group volume
heos.group_volume_upTurns up the volume of a HEOS group a step. -
Move queue item
heos.move_queue_itemReorders one or more items within a HEOS media player's play queue. -
Remove from queue
heos.remove_from_queueRemoves one or more items from a HEOS media player's play queue.
Hive
-
Boost heating off
hive.boost_heating_offTurns off the boost on a Hive heating zone or radiator valve. -
Boost heating on
hive.boost_heating_onBoosts a Hive heating zone or radiator valve to a target temperature for a set time. -
Boost hotwater
hive.boost_hot_waterTurns the boost on or off for a Hive hot water tank for a set time.
Home Assistant Core
-
Check Home Assistant configuration
homeassistant.check_configChecks the Home Assistant YAML configuration files for errors. -
Reload all Home Assistant configuration
homeassistant.reload_allReloads all YAML configuration that can be reloaded without a restart. -
Reload config entry
homeassistant.reload_config_entryReloads an integration's config entry without restarting Home Assistant. -
Reload Core configuration
homeassistant.reload_core_configReloads the Core configuration under the homeassistant section of your YAML. -
Reload custom Jinja2 templates
homeassistant.reload_custom_templatesReloads the custom Jinja2 templates from your custom_templates folder. -
Restart Home Assistant
homeassistant.restartRestarts Home Assistant after checking the configuration. -
Save persistent states
homeassistant.save_persistent_statesSaves the persistent states of entities immediately. -
Set Home Assistant location
homeassistant.set_locationUpdates the location of the Home Assistant home zone. -
Stop Home Assistant
homeassistant.stopStops the Home Assistant instance. -
Generic toggle
homeassistant.toggleToggles one or more entities across any domain on or off in a single action. -
Generic turn off
homeassistant.turn_offTurns off one or more entities across any domain in a single action. -
Generic turn on
homeassistant.turn_onTurns on one or more entities across any domain in a single action. -
Update entity
homeassistant.update_entityForces one or more entities to refresh their data right away.
HomeKit Bridge
-
Reload HomeKit
homekit.reloadReloads HomeKit and reprocesses the YAML configuration. -
Reset accessory
homekit.reset_accessoryResets a HomeKit accessory. -
Unpair an accessory or bridge
homekit.unpairForcefully removes all pairings from an accessory to allow re-pairing.
Lutron Homeworks
-
Send command
homeworks.send_commandSends a custom command to a Lutron Homeworks controller.
HTML5 Push Notifications
-
Dismiss message
html5.dismiss_messageDismiss a message. -
Send message
html5.send_messageSend a notification message via web push. Optionally customize the notification with images, action buttons, and other settings.
Huawei LTE
-
Resume integration
huawei_lte.resume_integrationResumes a suspended integration. -
Suspend integration
huawei_lte.suspend_integrationSuspends the integration and logs it out from the router.
Humidifier
-
Set humidifier target humidity
humidifier.set_humiditySets the target humidity of a humidifier. -
Set humidifier mode
humidifier.set_modeSets the mode of a humidifier. -
Toggle humidifier
humidifier.toggleToggles a humidifier on or off. -
Turn off humidifier
humidifier.turn_offTurns off a humidifier. -
Turn on humidifier
humidifier.turn_onTurns on a humidifier.
Husqvarna Automower
-
Override schedule
husqvarna_automower.override_scheduleLets the mower either mow or park for a given duration, overriding all schedules. -
Override schedule work area
husqvarna_automower.override_schedule_work_areaLets the mower mow for a given duration in a specified work area, overriding all schedules.
Hunter Hydrawise
-
Resume automatic watering
hydrawise.resumeResumes an irrigation zone's automatic watering schedule. -
Start watering
hydrawise.start_wateringStarts a watering cycle in the selected irrigation zone. -
Suspend automatic watering
hydrawise.suspendSuspends an irrigation zone's automatic watering schedule until the given date and time.
Image
-
Take image snapshot
image.snapshotSaves the current image from an image entity to a file.
IMAP
-
Delete message
imap.deleteDeletes an IMAP email message. -
Fetch message
imap.fetchFetches the text body and part metadata of an IMAP email message. -
Fetch message part
imap.fetch_partFetches a single part or attachment from an IMAP email message. -
Move message
imap.moveMoves an IMAP email message to another folder. -
Mark message as seen
imap.seenMarks an IMAP email message as seen.
Immich
-
Upload file
immich.upload_fileUploads a file to your Immich instance.
Indevolt
-
Charge
indevolt.chargeStarts charging an Indevolt battery until the target state of charge is reached. -
Discharge
indevolt.dischargeStarts discharging an Indevolt battery until the target state of charge is reached.
Input boolean
-
Reload input booleans
input_boolean.reloadReloads the input boolean helpers from the YAML configuration. -
Toggle input boolean
input_boolean.toggleToggles an input boolean between on and off. -
Turn off input boolean
input_boolean.turn_offTurns an input boolean off. -
Turn on input boolean
input_boolean.turn_onTurns an input boolean on.
Input button
-
Press input button
input_button.pressPresses an input button. -
Reload input buttons
input_button.reloadReloads the input button helpers from the YAML configuration.
Input Datetime
-
Reload input datetimes
input_datetime.reloadReloads the input datetime helpers from the YAML configuration. -
Set input datetime value
input_datetime.set_datetimeSets the date and/or time of an input datetime.
Input number
-
Decrement input number
input_number.decrementDecrements the value of an input number by 1 step. -
Increment input number
input_number.incrementIncrements the value of an input number by 1 step. -
Reload input numbers
input_number.reloadReloads the input number helpers from the YAML configuration. -
Set input number value
input_number.set_valueSets the value of an input number.
Input select
-
Reload input selects
input_select.reloadReloads the input select helpers from the YAML configuration. -
Select first input select option
input_select.select_firstSelects the first option of an input select. -
Select last input select option
input_select.select_lastSelects the last option of an input select. -
Select next input select option
input_select.select_nextSelects the next option of an input select. -
Select input select option
input_select.select_optionSelects an option of an input select. -
Select previous input select option
input_select.select_previousSelects the previous option of an input select. -
Set input select options
input_select.set_optionsSets the options of an input select.
Input text
-
Reload input texts
input_text.reloadReloads the input text helpers from the YAML configuration. -
Set input text value
input_text.set_valueSets the value of an input text.
Intent Script
-
Reload intent scripts
intent_script.reloadReloads the intent scripts from the YAML configuration.
Iperf3
-
Speedtest
iperf3.speedtestRuns an iperf3 speed test on demand.
Universal Devices ISY/IoX
-
Delete Z-Wave lock user code
isy994.delete_zwave_lock_user_codeDeletes a user code from a Z-Wave lock through the ISY. -
Get Z-Wave parameter
isy994.get_zwave_parameterRequests a Z-Wave device parameter through the ISY. -
Rename node
isy994.rename_nodeRenames a node or scene on the ISY. -
Send node command
isy994.send_node_commandSends a command to an ISY node using its Home Assistant entity. -
Send program command
isy994.send_program_commandSends a command to control an ISY program or folder. -
Send raw node command
isy994.send_raw_node_commandSends a raw ISY REST command to a node using its Home Assistant entity. -
Set Z-Wave lock user code
isy994.set_zwave_lock_user_codeSets a user code on a Z-Wave lock through the ISY. -
Set Z-Wave parameter
isy994.set_zwave_parameterUpdates a Z-Wave device parameter through the ISY.
iZone
-
Set maximum airflow
izone.airflow_maxSets the maximum airflow percentage for an iZone zone. -
Set minimum airflow
izone.airflow_minSets the minimum airflow percentage for an iZone zone.
Jellyfin
-
Play media shuffled
jellyfin.play_media_shuffleStart playing a Jellyfin directory shuffled, replacing the current play queue.
Kodi
-
Add music to the Kodi playlist
kodi.add_to_playlistAdds music to the default Kodi playlist. -
Call a Kodi JSON-RPC API method
kodi.call_methodCalls a Kodi JSON-RPC API method with optional parameters.
LaMetric
-
Display a chart
lametric.chartDisplay a chart on a LaMetric device from a list of numeric data points. -
Display a message
lametric.messageDisplay a message, with an optional icon, on a LaMetric device.
Lawn mower
-
Return lawn mower to dock
lawn_mower.dockReturns a lawn mower to its dock. -
Pause lawn mower
lawn_mower.pausePauses a lawn mower's current task. -
Start lawn mower
lawn_mower.start_mowingStarts or resumes a lawn mower's mowing task.
Light
-
Toggle a light
light.toggleFlip a light between on and off. If it's off, it turns on. If it's on, it turns off. -
Turn off a light
light.turn_offTurn a light off. Optionally fade it out with a transition, or have it flash briefly before it goes dark. -
Turn on a light
light.turn_onTurn a light on. Optionally set brightness, color, color temperature, an effect, or a transition.
LinkPlay
-
Play preset
linkplay.play_presetPlays a preset stored on a LinkPlay media player.
Whisker
-
Set sleep mode
litterrobot.set_sleep_modeSets the sleep mode and start time on a Litter-Robot.
Lock
-
Lock lock
lock.lockLocks one or more locks. -
Open lock
lock.openUnlatches one or more locks that support opening. -
Unlock lock
lock.unlockUnlocks one or more locks.
Logger
-
Set logger default level
logger.set_default_levelSets the default log level for loggers without an explicit level. -
Set logger level
logger.set_levelSets the log level for one or more integrations.
Mastodon
-
Get account
mastodon.get_accountGets information about a Mastodon account. -
Mute account
mastodon.mute_accountMutes a Mastodon account. -
Post
mastodon.postPosts a status on your Mastodon account. -
Unmute account
mastodon.unmute_accountUnmutes a Mastodon account. -
Update profile
mastodon.update_profileUpdates your Mastodon profile information and pictures.
Matrix
-
React
matrix.reactSends a reaction to a message in a Matrix room. -
Send message
matrix.send_messageSends a message to one or more Matrix rooms.
Matter
-
Clear a Matter lock credential
matter.clear_lock_credentialRemoves a credential, such as a PIN, from a Matter lock. -
Clear a Matter lock user
matter.clear_lock_userDeletes a user and their credentials from a Matter lock. -
Get Matter lock credential status
matter.get_lock_credential_statusReturns the status of a credential slot on a Matter lock. -
Get Matter lock info
matter.get_lock_infoReturns the capabilities of a Matter lock. -
Get Matter lock users
matter.get_lock_usersReturns all users configured on a Matter lock. -
Set a Matter lock credential
matter.set_lock_credentialAdds or updates a credential, such as a PIN, on a Matter lock. -
Set a Matter lock user
matter.set_lock_userCreates or updates a user on a Matter lock. -
Boost a Matter water heater
matter.water_heater_boostEnables boost mode on a Matter water heater for a set duration.
Mealie
-
Get meal plan
mealie.get_mealplanGet the Mealie meal plan for a specified date range. -
Get recipe
mealie.get_recipeGet a Mealie recipe by its ID or slug. -
Get recipes
mealie.get_recipesSearch Mealie for recipes that match your search terms. -
Get shopping list items
mealie.get_shopping_list_itemsGet the items on a Mealie shopping list. -
Import recipe
mealie.import_recipeImport a recipe into Mealie from a URL. -
Set a meal plan
mealie.set_mealplanPlan a recipe or a meal note on a specific date in Mealie. -
Set random meal plan
mealie.set_random_mealplanPlan a random recipe on a specific date in Mealie.
Media player
-
Browse media
media_player.browse_mediaBrowses the media available on a media player. -
Clear media player playlist
media_player.clear_playlistRemoves all items from a media player's playlist. -
Join media players
media_player.joinGroups media players together for synchronous playback. -
Next track
media_player.media_next_trackSelects the next track on a media player. -
Pause media
media_player.media_pausePauses playback on a media player. -
Play media
media_player.media_playStarts playback on a media player. -
Play/Pause media
media_player.media_play_pauseToggles play and pause on a media player. -
Previous track
media_player.media_previous_trackSelects the previous track on a media player. -
Seek media
media_player.media_seekJumps to a different position in the media currently playing. -
Stop media
media_player.media_stopStops playback on a media player. -
Play media
media_player.play_mediaPlays specific media on a media player. -
Set media player repeat
media_player.repeat_setSets the repeat mode of a media player. -
Search media
media_player.search_mediaSearches the media available on a media player. -
Select media player sound mode
media_player.select_sound_modeSelects a sound mode of a media player. -
Select media player source
media_player.select_sourceChanges the input source of a media player. -
Set media player shuffle
media_player.shuffle_setEnables or disables shuffle mode on a media player. -
Toggle media player
media_player.toggleToggles a media player on or off. -
Turn off media player
media_player.turn_offTurns off a media player. -
Turn on media player
media_player.turn_onTurns on a media player. -
Unjoin media player
media_player.unjoinRemoves a media player from a group. -
Turn down media player volume
media_player.volume_downTurns down the volume of a media player. -
Mute/unmute media player
media_player.volume_muteMutes or unmutes a media player. -
Set media player volume
media_player.volume_setSets the volume level of a media player. -
Turn up media player volume
media_player.volume_upTurns up the volume of a media player.
Minio
-
Get file
minio.getDownloads a file from a MinIO bucket to the local file system. -
Put file
minio.putUploads a file from the local file system to a MinIO bucket. -
Remove file
minio.removeDeletes a file from a MinIO bucket.
Monoprice 6-Zone Amplifier
-
Restore a saved Monoprice zone snapshot
monoprice.restoreRestores one or more Monoprice amplifier zones to a previously saved state. -
Snapshot the current state of a Monoprice zone
monoprice.snapshotSaves the current state of one or more Monoprice amplifier zones so you can restore it later.
Motionblinds
-
Set absolute position
motion_blinds.set_absolute_positionMoves a Motionblinds cover to an exact position.
motionEye
-
Trigger motionEye action
motioneye.actionTriggers a motionEye action. -
Set text overlay
motioneye.set_text_overlaySets the text overlay for a camera. -
Snapshot
motioneye.snapshotTriggers a motionEye still snapshot.
Music Assistant
-
Get library items
music_assistant.get_libraryRetrieves items from a Music Assistant library. -
Get queue details
music_assistant.get_queueRetrieves the details of the active queue of a Music Assistant player. -
Play announcement
music_assistant.play_announcementPlays an announcement on a Music Assistant player with fine-grained control options. -
Play media
music_assistant.play_mediaPlays media on a Music Assistant player with fine-grained control options. -
Search Music Assistant
music_assistant.searchPerforms a global search on the Music Assistant library and all providers. -
Transfer queue
music_assistant.transfer_queueTransfers a player's queue to another Music Assistant player.
Ness Alarm
-
Aux
ness_alarm.auxChanges the state of an aux output on the Ness alarm panel. -
Panic
ness_alarm.panicTriggers a panic alarm on the Ness alarm panel.
Google Nest
-
Set fan timer
nest.set_fan_timerSets the Nest thermostat fan to run for a specific duration.
Netatmo
-
Clear temperature setting
netatmo.clear_temperature_settingClears a manual temperature setting on a Netatmo climate device. -
Register webhook
netatmo.register_webhookManually registers the Netatmo webhook with the Netatmo backend. -
Set camera light mode
netatmo.set_camera_lightSets the light mode of a Netatmo Outdoor camera. -
Set person away
netatmo.set_person_awayMarks a person as away for a Netatmo Indoor camera. -
Set persons at home
netatmo.set_persons_homeMarks a list of people as at home for a Netatmo Indoor camera. -
Set preset mode with end date & time
netatmo.set_preset_mode_with_end_datetimeSets a preset mode for a Netatmo climate device until a chosen date and time. -
Set heating schedule
netatmo.set_scheduleActivates a heating schedule for a Netatmo climate device. -
Set temperature with end date & time
netatmo.set_temperature_with_end_datetimeSets a target temperature for a Netatmo climate device until a chosen date and time. -
Set temperature with time period
netatmo.set_temperature_with_time_periodSets a target temperature for a Netatmo climate device for a chosen length of time. -
Unregister webhook
netatmo.unregister_webhookManually unregisters the Netatmo webhook from the Netatmo backend.
NETGEAR LTE
-
Connect LTE
netgear_lte.connect_lteAsks the NETGEAR LTE modem to establish its LTE connection. -
Delete SMS
netgear_lte.delete_smsDeletes messages from the NETGEAR LTE modem inbox. -
Disconnect LTE
netgear_lte.disconnect_lteAsks the NETGEAR LTE modem to close its LTE connection. -
Set option
netgear_lte.set_optionSets connection options on the NETGEAR LTE modem.
Nintendo Switch parental controls
-
Add bonus time
nintendo_parental_controls.add_bonus_timeAdds bonus screen time to a Nintendo Switch.
Nord Pool
-
Get price indices for date
nordpool.get_price_indices_for_dateRetrieves the price indices for a specific date. -
Get prices for date
nordpool.get_prices_for_dateRetrieves the prices for a specific date.
ntfy
-
Dismiss notification
ntfy.clearDismiss a message from a ntfy topic by marking it as read. -
Delete notification
ntfy.deleteDelete a notification from a ntfy topic. -
Publish notification
ntfy.publishPublish a notification to a ntfy topic. Optionally customize message content and appearance with priority, links, attachments, tags, emojis, and more.
Nuki Bridge
-
Lock 'n' Go
nuki.lock_n_goUnlocks a Nuki lock, waits a few seconds, then locks it again. -
Set continuous mode
nuki.set_continuous_modeEnables or disables continuous mode on a Nuki Opener.
Number
-
Set number value
number.set_valueSets the value of a number entity.
National Weather Service (NWS)
-
Get extra forecasts data
nws.get_forecasts_extraRetrieves extra data for weather forecasts.
NX584
-
Bypass zone
nx584.bypass_zoneBypasses a zone on an NX584 alarm panel. -
Unbypass zone
nx584.unbypass_zoneRemoves the bypass from a zone on an NX584 alarm panel.
OctoPrint
-
Connect to a printer
octoprint.printer_connectInstructs the OctoPrint server to connect to a printer.
Ohme
-
List charge slots
ohme.list_charge_slotsReturns a list of charge slots. -
Set price cap
ohme.set_price_capPrevents charging when the electricity price exceeds a defined threshold.
Ombi
-
Submit movie request
ombi.submit_movie_requestSearches for a movie and requests the first result in Ombi. -
Submit music request
ombi.submit_music_requestSearches for a music album and requests the first result in Ombi. -
Submit TV request
ombi.submit_tv_requestSearches for a TV show and requests the first result in Ombi.
OpenDisplay
-
Upload image
opendisplay.upload_imageUploads an image to an OpenDisplay device.
Linn / OpenHome
-
Play pin
openhome.invoke_pinStarts playing content pinned on a Linn or OpenHome device.
OpenTherm Gateway
-
Reset gateway
opentherm_gw.reset_gatewayResets the OpenTherm Gateway. -
Send transparent command
opentherm_gw.send_transparent_commandSends a custom OpenTherm Gateway command through a transparent interface. -
Set central heating override
opentherm_gw.set_central_heating_ovrdSets the central heating override option on the gateway. -
Set clock
opentherm_gw.set_clockSets the clock and day of the week on the connected thermostat. -
Set control setpoint
opentherm_gw.set_control_setpointSets the central heating control setpoint override on the gateway. -
Set GPIO mode
opentherm_gw.set_gpio_modeChanges the function of the GPIO pins of the gateway. -
Set hot water override
opentherm_gw.set_hot_water_ovrdSets the domestic hot water enable option on the gateway. -
Set hot water setpoint
opentherm_gw.set_hot_water_setpointSets the domestic hot water setpoint on the gateway. -
Set LED mode
opentherm_gw.set_led_modeChanges the function of the LEDs of the gateway. -
Set max modulation
opentherm_gw.set_max_modulationOverrides the maximum relative modulation level on the gateway. -
Set outside temperature
opentherm_gw.set_outside_temperatureProvides an outside temperature to the thermostat. -
Set setback temperature
opentherm_gw.set_setback_temperatureConfigures the setback temperature used with the GPIO home and away modes.
OpenWeatherMap
-
Get minute forecast
openweathermap.get_minute_forecastRetrieves a minute-by-minute precipitation forecast for the next hour from OpenWeatherMap.
Overkiz
-
Set cover position and tilt
overkiz.set_cover_position_and_tiltMove a cover to a target position and tilt at the same time, keeping the motor running smoothly through the move.
Seerr
-
Get requests
overseerr.get_requestsRetrieves a list of media requests from Seerr.
Person
-
Reload persons
person.reloadReloads persons from the YAML configuration.
Pi-hole
-
Disable Pi-hole
pi_hole.disableTemporarily disables ad-blocking on your Pi-hole for a set amount of time.
Picnic
-
Add a product to the cart
picnic.add_productAdds a product to your Picnic shopping cart by product ID or by searching for a product name.
Plex Media Server
-
Refresh library
plex.refresh_libraryRefreshes a Plex library to scan for new and updated media.
Portainer
-
Prune unused images
portainer.prune_imagesRemoves unused images from a Portainer endpoint. -
Recreate container
portainer.recreate_containerRecreates a container on a Portainer endpoint.
Prosegur Alarm
-
Request image
prosegur.request_imageAsks the Prosegur cloud service for a new image from a camera.
Sony PlayStation 4
-
Send command
ps4.send_commandEmulates a button press on a PlayStation 4.
Python Scripts
-
Reload Python scripts
python_script.reloadReloads the available Python scripts from the `/python_scripts` folder.
qBittorrent
-
Get all torrents
qbittorrent.get_all_torrentsGets the current torrents from all qBittorrent instances. -
Get torrents
qbittorrent.get_torrentsGets the current torrents from one qBittorrent instance.
Rachio
-
Pause watering
rachio.pause_wateringPauses any currently running zones or schedules. -
Resume watering
rachio.resume_wateringResumes any paused zone runs or schedules. -
Set zone moisture percent
rachio.set_zone_moisture_percentSets the moisture percentage of one or more sprinkler zones. -
Start multiple zones
rachio.start_multiple_zone_scheduleCreates a custom schedule from a list of zones and run times. -
Start watering
rachio.start_wateringStarts a single zone, a schedule, or any number of smart hose timer valves. -
Stop watering
rachio.stop_wateringStops any currently running zones or schedules.
Radarr
-
Get movies
radarr.get_moviesGets all movies in Radarr with their details and status. -
Get queue
radarr.get_queueGets all movies currently in the Radarr download queue with their progress and details.
Rain Bird
-
Start irrigation
rainbird.start_irrigationStarts a Rain Bird sprinkler zone for a set number of minutes.
RainMachine
-
Pause all watering
rainmachine.pause_wateringPauses all watering activities for a number of seconds. -
Push flow meter data
rainmachine.push_flow_meter_dataSends flow meter data from Home Assistant to the RainMachine device. -
Push weather data
rainmachine.push_weather_dataSends weather data from Home Assistant to the RainMachine device. -
Restrict all watering
rainmachine.restrict_wateringRestricts all watering activities from starting for a time period. -
Start program
rainmachine.start_programStarts a RainMachine program. -
Start zone
rainmachine.start_zoneStarts a RainMachine zone for a set time. -
Stop all watering
rainmachine.stop_allStops all watering activities. -
Stop program
rainmachine.stop_programStops a RainMachine program. -
Stop zone
rainmachine.stop_zoneStops a RainMachine zone. -
Unpause all watering
rainmachine.unpause_wateringResumes all paused watering activities. -
Unrestrict all watering
rainmachine.unrestrict_wateringRemoves all watering restrictions.
Recorder
-
Disable Recorder
recorder.disableStops recording events and state changes to the database. -
Enable Recorder
recorder.enableResumes recording events and state changes to the database. -
Get Recorder statistics
recorder.get_statisticsRetrieves long-term statistics for one or more entities. -
Purge Recorder database
recorder.purgeCleans up old data from the recorder database. -
Purge Recorder entities
recorder.purge_entitiesRemoves recorded data for specific entities, domains, or patterns.
Renson
-
Set Breeze
renson.set_breezeConfigures the Breeze function of the Renson ventilation unit. -
Set pollution settings
renson.set_pollution_settingsConfigures the pollution settings of the Renson ventilation unit. -
Set timer
renson.set_timer_levelRuns the Renson ventilation unit at a chosen level for a set time.
Reolink
-
Play chime
reolink.play_chimePlays a ringtone on a Reolink Chime. -
PTZ move
reolink.ptz_moveMoves a Reolink camera at a specific speed.
Risco
-
Set the alarm panel time
risco.set_timeSets the time of a Risco alarm panel.
Roborock
-
Get maps
roborock.get_mapsRetrieves the map and room information of a Roborock vacuum. -
Get current position
roborock.get_vacuum_current_positionRetrieves the current position of a Roborock vacuum. -
Go to position
roborock.set_vacuum_goto_positionSends a Roborock vacuum to a specific position.
Roku
-
Search
roku.searchOpen the search screen on a Roku device and enter a search keyword.
AWS Route53
-
Update records
route53.update_recordsUpdates your AWS Route53 DNS records with your current public IP address.
Saunum
-
Start session
saunum.start_sessionStarts a sauna session with a custom duration, target temperature, and fan duration.
Schedule
-
Get schedule
schedule.get_scheduleRetrieves the configured time ranges of one or more schedules. -
Reload schedules
schedule.reloadReloads schedules from your YAML configuration.
Pentair ScreenLogic
-
Set color mode
screenlogic.set_color_modeSets the color mode for all color-capable lights on a ScreenLogic gateway. -
Start super chlorination
screenlogic.start_super_chlorinationStarts super chlorination on a ScreenLogic gateway. -
Stop super chlorination
screenlogic.stop_super_chlorinationStops super chlorination on a ScreenLogic gateway.
Select
-
Select first option
select.select_firstSelects the first option of a select entity. -
Select last option
select.select_lastSelects the last option of a select entity. -
Select next option
select.select_nextSelects the next option of a select entity. -
Select option
select.select_optionSelects a specific option of a select entity. -
Select previous option
select.select_previousSelects the previous option of a select entity.
17TRACK
-
Add a package
seventeentrack.add_packageAdds a package to 17Track by tracking number. -
Archive package
seventeentrack.archive_packageArchives a package in 17Track by tracking number. -
Get packages
seventeentrack.get_packagesQueries the 17Track API for the latest package data.
Shelly
-
Get Shelly KVS value
shelly.get_kvs_valueReads a value from a Shelly device's Key-Value Storage. -
Set Shelly KVS value
shelly.set_kvs_valueStores a value in a Shelly device's Key-Value Storage.
Shopping list
-
Add shopping list item
shopping_list.add_itemAdds an item to the shopping list. -
Clear completed shopping list items
shopping_list.clear_completed_itemsRemoves completed items from the shopping list. -
Complete all shopping list items
shopping_list.complete_allMarks all items as completed in the shopping list. -
Complete shopping list item
shopping_list.complete_itemMarks the first item with matching name as completed in the shopping list. -
Incomplete all shopping list items
shopping_list.incomplete_allMarks all items as incomplete in the shopping list. -
Incomplete shopping list item
shopping_list.incomplete_itemMarks the first item with matching name as incomplete in the shopping list. -
Remove shopping list item
shopping_list.remove_itemRemoves the first item with matching name from the shopping list. -
Sort shopping list items
shopping_list.sortSorts all items by name in the shopping list.
SimpliSafe
-
Remove PIN
simplisafe.remove_pinRemoves a SimpliSafe PIN by its label or value. -
Set PIN
simplisafe.set_pinSets or updates a SimpliSafe PIN. -
Set system properties
simplisafe.set_system_propertiesSets one or more properties on a SimpliSafe system.
Siren
-
Toggle siren
siren.toggleToggles a siren on or off. -
Turn off siren
siren.turn_offTurns off a siren. -
Turn on siren
siren.turn_onTurns on a siren.
SMLIGHT SLZB
-
Play RTTTL tone
smlight.play_rtttlPlay a Ring Tone Text Transfer Language (RTTTL) tone on the built-in buzzer of a SMLIGHT Ultima device.
Snapcast
-
Restore
snapcast.restoreRestores a previously taken snapshot of one or more Snapcast speakers. -
Set latency
snapcast.set_latencySets the latency of a Snapcast speaker. -
Snapshot
snapcast.snapshotTakes a snapshot of what is currently playing on one or more Snapcast speakers.
Snooz
-
Transition off
snooz.transition_offGradually lowers a Snooz device's volume, then turns it off. -
Transition on
snooz.transition_onGradually changes a Snooz device's volume over a set duration.
Sonarr
-
Get disk space
sonarr.get_diskspaceRetrieves the disk space information for all storage locations configured in Sonarr. -
Get episodes
sonarr.get_episodesRetrieves all episodes for a specific series in your Sonarr library. -
Get queue
sonarr.get_queueRetrieves the episodes currently in the Sonarr download queue with their progress and details. -
Get series
sonarr.get_seriesRetrieves all series in your Sonarr library with their details and statistics. -
Get upcoming
sonarr.get_upcomingRetrieves upcoming episodes from the Sonarr calendar. -
Get wanted
sonarr.get_wantedRetrieves wanted (missing) episodes that Sonarr is searching for.
Sonos
-
Clear a Sonos sleep timer
sonos.clear_sleep_timerClears the sleep timer on a Sonos speaker. -
Get the Sonos queue
sonos.get_queueReturns the contents of a Sonos speaker's queue. -
Play the Sonos queue
sonos.play_queueStarts playing the Sonos queue, optionally from a specific position. -
Remove from the Sonos queue
sonos.remove_from_queueRemoves an item from a Sonos speaker's queue. -
Restore a Sonos snapshot
sonos.restoreRestores a previously taken snapshot on one or more Sonos speakers. -
Set a Sonos sleep timer
sonos.set_sleep_timerSets a sleep timer that gradually fades out a Sonos speaker. -
Take a Sonos snapshot
sonos.snapshotSaves what is currently playing on one or more Sonos speakers so you can restore it later. -
Update a Sonos alarm
sonos.update_alarmUpdates the time, volume, and other settings of an existing Sonos alarm.
Bose SoundTouch
-
Add zone follower
soundtouch.add_zone_slaveAdds media players to an existing Bose SoundTouch zone. -
Create zone
soundtouch.create_zoneCreates a Bose SoundTouch multi-room zone. -
Play everywhere
soundtouch.play_everywherePlays the same content on all Bose SoundTouch devices. -
Remove zone follower
soundtouch.remove_zone_slaveRemoves media players from an existing Bose SoundTouch zone.
SQL
-
Query
sql.queryExecutes a read-only SQL query and returns the result.
Squeezebox (Lyrion Music Server)
-
Call method
squeezebox.call_methodCall a custom Squeezebox JSON-RPC API command on a Lyrion Music Server. -
Call query
squeezebox.call_queryCall a custom Squeezebox JSON-RPC API query and store the result on the player.
StarLine
-
Set scan interval
starline.set_scan_intervalSets how often Home Assistant fetches StarLine entity updates. -
Set scan OBD interval
starline.set_scan_obd_intervalSets how often Home Assistant fetches StarLine OBD updates. -
Update state
starline.update_stateFetches the latest state of your StarLine devices from the StarLine server.
Stookwijzer
-
Get forecast
stookwijzer.get_forecastRetrieves the advice forecast from Stookwijzer.
StreamLabs
-
Set away mode
streamlabswater.set_away_modeSets the home or away mode for a StreamLabs Water Monitor.
Sure Petcare
-
Set lock state
surepetcare.set_lock_stateChanges the locking state of a Sure Petcare flap. -
Set pet location
surepetcare.set_pet_locationManually sets the location of a pet to inside or outside.
Swiss public transport
-
Fetch connections
swiss_public_transport.fetch_connectionsFetches a list of upcoming connections from Swiss public transport.
SwitchBot Bluetooth
-
Add password
switchbot.add_passwordAdds a password to a SwitchBot Keypad Vision device.
Switcher
-
Set auto-off
switcher_kis.set_auto_offSets the auto-off time for a Switcher power device. -
Turn on with timer
switcher_kis.turn_on_with_timerTurns on a Switcher power device for a set number of minutes.
System Bridge
-
Get process by ID
system_bridge.get_process_by_idGets a running process from a System Bridge server by its process ID. -
Get processes by name
system_bridge.get_processes_by_nameGets the running processes from a System Bridge server that match a name. -
Open path
system_bridge.open_pathOpens a file on a System Bridge server with the default application. -
Open URL
system_bridge.open_urlOpens a URL on a System Bridge server with the default application. -
Power command
system_bridge.power_commandSends a power command to a System Bridge server. -
Send keyboard keypress
system_bridge.send_keypressSends a keyboard keypress to a System Bridge server. -
Send keyboard text
system_bridge.send_textSends text for a System Bridge server to type.
System Log
-
Clear system log
system_log.clearClears all stored entries from the Home Assistant system log. -
Write to system log
system_log.writeWrites a custom entry to the Home Assistant system log.
Telegram bot
-
Answer callback query
telegram_bot.answer_callback_queryResponds to a button press on a Telegram inline keyboard. -
Delete message
telegram_bot.delete_messageDeletes a message a Telegram bot sent earlier. -
Download file
telegram_bot.download_fileDownloads a file received by a Telegram bot to local storage. -
Edit caption
telegram_bot.edit_captionEdits the caption of a media message a Telegram bot sent earlier. -
Edit message
telegram_bot.edit_messageEdits the text of a message a Telegram bot sent earlier. -
Edit message media
telegram_bot.edit_message_mediaReplaces the media of a message a Telegram bot sent earlier. -
Edit reply markup
telegram_bot.edit_replymarkupEdits the inline keyboard of a message a Telegram bot sent earlier. -
Leave chat
telegram_bot.leave_chatRemoves a Telegram bot from a chat. -
Send animation
telegram_bot.send_animationSends an animation through a Telegram bot to one or more chats. -
Send chat action
telegram_bot.send_chat_actionShows a status such as typing in a Telegram chat. -
Send document
telegram_bot.send_documentSends a document through a Telegram bot to one or more chats. -
Send location
telegram_bot.send_locationSends a location through a Telegram bot to one or more chats. -
Send media group
telegram_bot.send_media_groupSends a group of photos, videos, documents, or audio files as an album. -
Send message
telegram_bot.send_messageSends a text message through a Telegram bot to one or more chats. -
Send message draft
telegram_bot.send_message_draftShows a temporary draft message in a Telegram chat. -
Send photo
telegram_bot.send_photoSends a photo through a Telegram bot to one or more chats. -
Send poll
telegram_bot.send_pollSends a poll through a Telegram bot to one or more chats. -
Send sticker
telegram_bot.send_stickerSends a sticker through a Telegram bot to one or more chats. -
Send video
telegram_bot.send_videoSends a video through a Telegram bot to one or more chats. -
Send voice
telegram_bot.send_voiceSends a voice message through a Telegram bot to one or more chats. -
Set message reaction
telegram_bot.set_message_reactionSets a Telegram bot's emoji reaction on a message.
Text
-
Set text value
text.set_valueSets the value of a text entity.
Time
-
Set time value
time.set_valueSets the value of a time entity.
Timer
-
Cancel a timer
timer.cancelCancels a running or paused timer without firing the finished event. -
Change a timer
timer.changeAdds or subtracts time on a running timer. -
Finish a timer
timer.finishFinishes a running or paused timer earlier than scheduled. -
Pause a timer
timer.pausePauses a running timer, keeping the remaining time. -
Reload timers
timer.reloadReloads timers from the YAML configuration. -
Start a timer
timer.startStarts a timer, or restarts it with a new duration.
To-do list
-
Add to-do list item
todo.add_itemAdds a new item to a to-do list. -
Get to-do list items
todo.get_itemsGets the items on a to-do list. -
Remove completed to-do list items
todo.remove_completed_itemsRemoves all completed items from a to-do list. -
Remove to-do list item
todo.remove_itemRemoves an item from a to-do list. -
Update to-do list item
todo.update_itemUpdates an existing item on a to-do list.
Todoist
-
New task
todoist.new_taskCreates a new Todoist task and adds it to a project.
Total Connect
-
Arm away instant
totalconnect.arm_away_instantArms the alarm panel in away mode with zero entry delay. -
Arm home instant
totalconnect.arm_home_instantArms the alarm panel in home mode with zero entry delay.
TP-Link Smart Home
-
Random effect
tplink.random_effectSets a random light effect on a TP-Link light strip. -
Sequence effect
tplink.sequence_effectSets a sequence light effect on a TP-Link light strip.
TP-Link Omada
-
Reconnect wireless client
tplink_omada.reconnect_clientForces a wireless client to reconnect to the Omada network.
Transmission
-
Add torrent
transmission.add_torrentAdds a new torrent to download in Transmission. -
Get torrents
transmission.get_torrentsReturns the current torrents in Transmission. -
Remove torrent
transmission.remove_torrentRemoves a torrent from Transmission. -
Start torrent
transmission.start_torrentStarts a torrent in Transmission. -
Stop torrent
transmission.stop_torrentStops a torrent in Transmission.
Text-to-speech (TTS)
-
Clear TTS cache
tts.clear_cacheRemoves all cached text-to-speech files and clears the memory. -
Say a TTS message
tts.saySays a message on a media player using a legacy text-to-speech platform. -
Speak
tts.speakSpeaks a message on a media player using text-to-speech.
Tuya
-
Get feeder meal plan data
tuya.get_feeder_meal_planRetrieves the feeding schedule from a Tuya pet feeder. -
Set feeder meal plan data
tuya.set_feeder_meal_planSets the feeding schedule on a Tuya pet feeder.
UniFi Network
-
Reconnect wireless client
unifi.reconnect_clientTries to get a wireless client to reconnect to the UniFi network. -
Remove clients from the UniFi Network
unifi.remove_clientsCleans up short-lived clients from the UniFi Network application.
UniFi Protect
-
Add doorbell text
unifiprotect.add_doorbell_textAdds a custom message that can be shown on a UniFi Protect doorbell. -
Get user keyring info
unifiprotect.get_user_keyring_infoReturns the UniFi Protect users along with their NFC and fingerprint keys. -
PTZ go to preset
unifiprotect.ptz_goto_presetMoves a UniFi Protect PTZ camera to a saved preset position. -
Remove doorbell text
unifiprotect.remove_doorbell_textRemoves a custom message from a UniFi Protect doorbell. -
Remove privacy zone
unifiprotect.remove_privacy_zoneRemoves a privacy zone from a UniFi Protect camera. -
Set chime paired doorbells
unifiprotect.set_chime_paired_doorbellsPairs one or more doorbells with a UniFi Protect smart chime.
Universal Powerline Bus (UPB)
-
Blink light
upb.light_blinkStarts a UPB light blinking at a set rate. -
Start light fade
upb.light_fade_startStarts fading a UPB light up or down to a target brightness. -
Stop light fade
upb.light_fade_stopStops a running fade or transition on a UPB light. -
Blink link
upb.link_blinkStarts a UPB scene blinking at a set rate. -
Deactivate link
upb.link_deactivateDeactivates a UPB scene. -
Start link fade
upb.link_fade_startStarts fading a UPB scene up or down to a target brightness. -
Stop link fade
upb.link_fade_stopStops a running fade or transition on a UPB scene. -
Go to link
upb.link_gotoSets a UPB scene to a target brightness.
Update
-
Clear skipped update
update.clear_skippedRemoves the skipped version marker from an update. -
Install update
update.installInstalls an update for a device or service. -
Skip update
update.skipMarks a currently available update as skipped.
Utility Meter
-
Calibrate a utility meter
utility_meter.calibrateSets a utility meter sensor to a specific value. -
Reset a utility meter
utility_meter.resetResets all counters of a utility meter back to zero.
Vacuum
-
Clean area
vacuum.clean_areaCleans specific mapped areas using vacuum segments. -
Clean spot
vacuum.clean_spotPerforms a spot cleaning at the vacuum's location. -
Locate vacuum
vacuum.locatePlays a sound or flashes lights to help you find the vacuum. -
Pause cleaning
vacuum.pausePauses the current cleaning task on a vacuum. -
Return to base
vacuum.return_to_baseSends the vacuum to the charging dock. -
Send command
vacuum.send_commandSend a platform-specific command. -
Set fan speed
vacuum.set_fan_speedSets the fan/power level for cleaning. -
Start cleaning
vacuum.startStarts or resumes a cleaning task on a vacuum. -
Start or pause cleaning
vacuum.start_pauseStarts, pauses, or resumes a vacuum cleaner's cleaning task. -
Stop vacuum
vacuum.stopStops the current activity of a vacuum. -
Toggle vacuum power
vacuum.toggleToggles a vacuum cleaner on or off. -
Turn off vacuum
vacuum.turn_offTurns off a vacuum cleaner. -
Turn on vacuum
vacuum.turn_onTurns on a vacuum cleaner.
Valve
-
Close valve
valve.close_valveCloses a valve. -
Open valve
valve.open_valveOpens a valve. -
Set valve position
valve.set_valve_positionMoves a valve to a specific position. -
Stop valve
valve.stop_valveStops a moving valve. -
Toggle valve
valve.toggleToggles a valve open or closed.
Velbus
-
Clear cache
velbus.clear_cacheClears the Velbus cache and starts a new scan. -
Scan
velbus.scanScans the Velbus modules on the bus. -
Set memo text
velbus.set_memo_textShows memo text on the display of Velbus modules. -
Sync clock
velbus.sync_clockSynchronizes the clock of the Velbus modules to the Home Assistant clock.
Verisure
-
Capture SmartCam image
verisure.capture_smartcamCaptures a new image from a Verisure SmartCam. -
Disable autolock
verisure.disable_autolockDisables autolock on a Verisure Lockguard Smartlock. -
Enable autolock
verisure.enable_autolockEnables autolock on a Verisure Lockguard Smartlock.
VeSync
-
Update devices
vesync.update_devicesPolls the VeSync server to find and add any new devices.
VIZIO SmartCast
-
Update setting
vizio.update_settingUpdates the value of a setting on a VIZIO SmartCast device.
Wake on LAN
-
Send magic packet
wake_on_lan.send_magic_packetSends a magic packet to wake up a device with Wake-on-LAN capabilities.
Water heater
-
Set water heater away mode
water_heater.set_away_modeTurns away mode on or off for a water heater. -
Set water heater operation mode
water_heater.set_operation_modeSets the operation mode of a water heater. -
Set water heater target temperature
water_heater.set_temperatureSets the target temperature of a water heater. -
Turn off water heater
water_heater.turn_offTurns off a water heater. -
Turn on water heater
water_heater.turn_onTurns on a water heater.
Watts Vision +
-
Activate timer mode
watts.activate_timer_modeSet a thermostat to timer mode with a target temperature and duration.
Waze Travel Time
-
Get travel times
waze_travel_time.get_travel_timesRetrieves route alternatives and travel times between two locations.
Weather
-
Get weather forecasts
weather.get_forecastsRetrieves the forecasts from one or more weather entities.
LG webOS TV
-
Button
webostv.buttonSimulates a button press on the remote of an LG webOS TV. -
Command
webostv.commandSends a generic command to an LG webOS TV. -
Select sound output
webostv.select_sound_outputChanges the active sound output of an LG webOS TV.
Workday
-
Check date
workday.check_dateChecks whether a given date is a workday.
Xiaomi Sensor
-
Add device
xiaomi_aqara.add_deviceEnables pairing mode on a Xiaomi Aqara Gateway to add a new device. -
Play ringtone
xiaomi_aqara.play_ringtonePlays a specific ringtone on a Xiaomi Aqara Gateway. -
Remove device
xiaomi_aqara.remove_deviceRemoves a specific device from a Xiaomi Aqara Gateway. -
Stop ringtone
xiaomi_aqara.stop_ringtoneStops a playing ringtone on a Xiaomi Aqara Gateway.
Xiaomi Home
-
Fan reset filter
xiaomi_miio.fan_reset_filterResets the filter lifetime and usage of a Xiaomi air purifier. -
Fan set extra features
xiaomi_miio.fan_set_extra_featuresSets a storage register that unlocks extra features in the Mi Home app. -
Light eyecare mode off
xiaomi_miio.light_eyecare_mode_offTurns off eyecare mode on a Xiaomi Philips Eyecare Smart Lamp 2. -
Light eyecare mode on
xiaomi_miio.light_eyecare_mode_onTurns on eyecare mode on a Xiaomi Philips Eyecare Smart Lamp 2. -
Light night light mode off
xiaomi_miio.light_night_light_mode_offTurns off night light mode on a Xiaomi Philips Eyecare Smart Lamp 2. -
Light night light mode on
xiaomi_miio.light_night_light_mode_onTurns on night light mode on a Xiaomi Philips Eyecare Smart Lamp 2. -
Light reminder off
xiaomi_miio.light_reminder_offDisables the eye fatigue reminder on a Xiaomi Philips Eyecare Smart Lamp 2. -
Light reminder on
xiaomi_miio.light_reminder_onEnables the eye fatigue reminder on a Xiaomi Philips Eyecare Smart Lamp 2. -
Light set delayed turn off
xiaomi_miio.light_set_delayed_turn_offSchedules a Xiaomi Philips light to turn off after a delay. -
Light set scene
xiaomi_miio.light_set_sceneSets a fixed scene on a Xiaomi Philips light. -
Remote learn command
xiaomi_miio.remote_learn_commandLearns an IR command with a Xiaomi IR remote. -
Remote set LED off
xiaomi_miio.remote_set_led_offTurns off the blue LED of a Xiaomi IR remote. -
Remote set LED on
xiaomi_miio.remote_set_led_onTurns on the blue LED of a Xiaomi IR remote. -
Switch set power mode
xiaomi_miio.switch_set_power_modeSets the power mode of a Xiaomi power strip. -
Switch set power price
xiaomi_miio.switch_set_power_priceSets the power price stored on a Xiaomi power strip. -
Switch set Wi-Fi LED off
xiaomi_miio.switch_set_wifi_led_offTurns off the Wi-Fi LED of a Xiaomi smart plug or power strip. -
Switch set Wi-Fi LED on
xiaomi_miio.switch_set_wifi_led_onTurns on the Wi-Fi LED of a Xiaomi smart plug or power strip. -
Vacuum clean segment
xiaomi_miio.vacuum_clean_segmentStarts a Xiaomi robot vacuum cleaning one or more segments or rooms. -
Vacuum clean zone
xiaomi_miio.vacuum_clean_zoneStarts a Xiaomi robot vacuum cleaning one or more rectangular zones. -
Vacuum go to
xiaomi_miio.vacuum_gotoSends a Xiaomi robot vacuum to a specific coordinate on its map. -
Vacuum remote control move
xiaomi_miio.vacuum_remote_control_moveSteers a Xiaomi robot vacuum while it is in remote control mode. -
Vacuum remote control move step
xiaomi_miio.vacuum_remote_control_move_stepMakes a Xiaomi robot vacuum perform a single remote control move. -
Vacuum remote control start
xiaomi_miio.vacuum_remote_control_startPuts a Xiaomi robot vacuum into remote control mode. -
Vacuum remote control stop
xiaomi_miio.vacuum_remote_control_stopTakes a Xiaomi robot vacuum out of remote control mode.
Yamaha Network Receivers
-
Enable output
yamaha.enable_outputEnables or disables an output port on a Yamaha receiver. -
Menu cursor
yamaha.menu_cursorControls the on-screen menu cursor of a Yamaha receiver. -
Select scene
yamaha.select_sceneSelects a scene on a Yamaha receiver.
Yardian
-
Start irrigation
yardian.start_irrigationStarts the irrigation for a zone for a set number of minutes.
Yeelight
-
Set auto delay off scene
yeelight.set_auto_delay_off_sceneTurns a Yeelight light on at a set brightness and schedules it to turn off after a delay. -
Set color flow scene
yeelight.set_color_flow_sceneStarts a color flow on a Yeelight light using the scene API call. -
Set color scene
yeelight.set_color_sceneSets a Yeelight light to a specific RGB color and brightness. -
Set color temperature scene
yeelight.set_color_temp_sceneSets a Yeelight light to a specific color temperature and brightness. -
Set HSV scene
yeelight.set_hsv_sceneSets a Yeelight light to a specific hue, saturation, and brightness. -
Set mode
yeelight.set_modeSets the operation mode of a Yeelight light. -
Set music mode
yeelight.set_music_modeEnables or disables music mode on a Yeelight light. -
Start flow
yeelight.start_flowStarts a color flow on a Yeelight light using a list of transitions.
YoLink
-
Play on SpeakerHub
yolink.play_on_speaker_hubConverts text to speech for playback on a YoLink SpeakerHub.
Z-Wave
-
Bulk set partial configuration parameters
zwave_js.bulk_set_partial_config_parametersSets multiple partial configuration parameters on a Z-Wave device at once. -
Clear lock user code
zwave_js.clear_lock_usercodeClears the user code from a code slot on a Z-Wave lock. -
Delete all credentials
zwave_js.delete_all_credentialsRemoves every credential belonging to a single user on a Z-Wave lock. -
Delete all users
zwave_js.delete_all_usersDeletes every access-control user and their credentials from a Z-Wave lock. -
Delete credential
zwave_js.delete_credentialRemoves a single credential from a user on a Z-Wave lock. -
Delete user
zwave_js.delete_userDeletes an access-control user and all their credentials from a Z-Wave lock. -
Get credential capabilities
zwave_js.get_credential_capabilitiesQueries the user and credential management capabilities of a Z-Wave lock. -
Get lock user code
zwave_js.get_lock_usercodeGets user codes from a Z-Wave lock. -
Get users
zwave_js.get_usersLists all access-control users and their credential references on a Z-Wave lock. -
Invoke a Command Class API on a node
zwave_js.invoke_cc_apiCalls a Command Class API directly on a Z-Wave node. -
Set a value on multiple devices via multicast
zwave_js.multicast_set_valueChanges a value on multiple Z-Wave devices at once using multicast. -
Refresh notifications on a node
zwave_js.refresh_notificationsRefreshes notifications on a Z-Wave node that supports the Notification Command Class. -
Refresh values
zwave_js.refresh_valueForces a refresh of the values of a Z-Wave entity. -
Reset meters on a node
zwave_js.reset_meterResets the meters on a Z-Wave node that supports the Meter Command Class. -
Set device configuration parameter
zwave_js.set_config_parameterChanges a configuration parameter on a Z-Wave device. -
Set credential
zwave_js.set_credentialAdds or updates a PIN code or password for an existing user on a Z-Wave lock. -
Set lock configuration
zwave_js.set_lock_configurationSets the configuration of a Z-Wave lock. -
Set lock user code
zwave_js.set_lock_usercodeSets a user code in a code slot on a Z-Wave lock. -
Set user
zwave_js.set_userCreates or updates an access-control user on a Z-Wave lock. -
Set a value
zwave_js.set_valueChanges any value that Z-Wave recognizes on a Z-Wave device.