From db195750477865e3fa9ad93f5a5d0b79c0ed4983 Mon Sep 17 00:00:00 2001 From: Russell VanderMey Date: Mon, 23 Sep 2024 09:52:30 -0400 Subject: [PATCH] Add TRIGGERcmd integration documentation (#33575) * Added triggercmd documentation page * Tweaked doccumentation * Take control of blueprint: update to reflect current SW (#33556) * Update source/_integrations/triggercmd.markdown Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * Update source/_integrations/triggercmd.markdown Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * Update source/_integrations/triggercmd.markdown Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * Update source/_integrations/triggercmd.markdown Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * Update source/_integrations/triggercmd.markdown Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * Update source/_integrations/triggercmd.markdown Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * Update source/_integrations/triggercmd.markdown Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * remove unrelated changes in Gemfile.lcok * Apply suggestions from code review * Apply suggestions from code review * fix version Co-authored-by: Joost Lekkerkerker * Tiny style tweaks * Update source/_integrations/triggercmd.markdown * Update source/_integrations/triggercmd.markdown * Move config flow after prereqs * move info about token to prereqs * Update source/_integrations/triggercmd.markdown * Update source/_integrations/triggercmd.markdown * Update source/_integrations/triggercmd.markdown --------- Co-authored-by: vel1kan Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com> Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> Co-authored-by: Joost Lekkerkerker --- source/_integrations/triggercmd.markdown | 36 ++++++++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 source/_integrations/triggercmd.markdown diff --git a/source/_integrations/triggercmd.markdown b/source/_integrations/triggercmd.markdown new file mode 100644 index 00000000000..61f76fba98c --- /dev/null +++ b/source/_integrations/triggercmd.markdown @@ -0,0 +1,36 @@ +--- +title: TRIGGERcmd +description: How to integrate TRIGGERcmd with Home Assistant. +ha_category: + - Switch + - Automation +ha_release: "2024.10" +ha_iot_class: Cloud Polling +ha_config_flow: true +ha_codeowners: + - '@rvmey' +ha_domain: triggercmd +ha_platforms: + - switch +ha_zeroconf: false +ha_integration_type: integration +--- + +The TRIGGERcmd {% term integration %} allows you to run commands on computers via [TRIGGERcmd](https://triggercmd.com/) with Home Assistant. + + +## Prerequisites + +To use TRIGGERcmd, you need the following: + +- A [TRIGGERcmd account](https://www.triggercmd.com/user/auth/signup) +- A computer with the TRIGGERcmd agent running on it +- For instructions on installing and using TRIGGERcmd itself, refer to the [TRIGGERcmd Quick Start Guide](https://docs.triggercmd.com/#/./QuickStart). +- After adding the TRIGGERcmd integration, you will be prompted for your **user token**. This can be found at the bottom of your TRIGGERcmd profile page or the instructions page. +{% include integrations/config_flow.md %} + +## Using TRIGGERcmd with Home Assistant + +All of your TRIGGERcmd commands should show up as **switch** devices. You can change the rooms of your devices, or select **Finish** to leave them without rooms. + +Using the switch will trigger the respective command. If you have **Allow parameters** enabled, your command will run with an "on" or "off" parameter, depending on whether you flip the switch in Home Assistant on or off.