Skip to content

Latest commit

 

History

History
77 lines (59 loc) · 3.31 KB

Actions.md

File metadata and controls

77 lines (59 loc) · 3.31 KB
Raw

Home | Switches | Actions | Templates | Background Service | Trouble Shooting | Version History

Actions

A simple example using a scene as a tap menu item.

{
  "entity": "scene.telly_watching",
  "name": "Telly Scene",
  "type": "tap",
  "tap_action": {
    "service": "scene.turn_on"
  }
},

Any menu item with an action (tap, template, or toggle), may have a confirmation view added. For consistency this is always done via the tap_action JSON object, even though for a toggle menu item there will only ever be a single field inside. For the toggle menu item, the confirmation is presented on both on and off directions. There is no option for asymmetry, i.e. only in one direction.

  "tap_action": {
    "confirm": true
  }

For example:

{
  "entity": "switch.garage_door",
  "name": "Garage Door",
  "type": "toggle",
  "tap_action": {
    "confirm": true
  }
}

The authors do not advise the use of this application for security sensitive devices. But we suspect users are taking that risk anyway, hence a PIN confirmation is provided that can be used for additional menu item security.

This can be enabled by setting the pin field in the tap_action. The pin field overrides confirm. Explicitly setting confirm is not necessary.

The 4-digit PIN is set globally for all actions in the app settings in Connect IQ.

  "tap_action": {
    "pin": true
  }

When entering an invalid PIN for the fifth time within 2 minutes, the PIN dialog will be locked for all actions for the next 10 minutes. Entering a valid PIN will always reset the failure counter.

Note that for notify events, you must not supply an entity_id or the API call will fail. There are other examples too.

{
  "name": "Message",
  "type": "tap",
  "tap_action": {
    "service": "notify.mobile_app_on_phone",
    "data": {
      "title": "This is a title",
      "message": "This is the message"
    },
    "confirm": true
  }
}

Important

Be careful with the value of the service field.

Note that the service field will need to be a locally custom script.<something> as soon as any data fields are populated and not something more generic like script.turn_on. If the service field is wrong, the application will fail with a Communications.INVALID_HTTP_BODY_IN_NETWORK_RESPONSE error in the response from your Home Assistant and show the error message as "No JSON returned from HTTP request" on your device. In the web-based editor you can use the standard developer tools to observe an HTTP 400 error which the application does not see. Here we are limited by the Garmin Connect IQ software development kit (SDK). We do not have enough information at the point of execution in the application to determine the cause of the error. Nor is there an immediately obvious way of identifying this issue using the JSON schema checks.