Compare commits

...

4 Commits

Author SHA1 Message Date
Philip Abbey
a97440b997 Preserve tap action data for numeric picker actions (#362)
Numeric menu items currently discard existing `tap_action.data` when
confirming a picker value. This prevents service call options such as
`transition` from being sent with `light.turn_on`.

This change passes `tap_action.data` into numeric menu items and merges
that data with the selected numeric picker value before calling the Home
Assistant service.

Example fixed payload:

```json
{
  "entity_id": "light.living_room",
  "transition": 2,
  "brightness": 128
}

Tested with a Forerunner 965 build and a Home Assistant light brightness numeric picker.
2026-06-23 23:27:45 +01:00
StumblingGamer
17690d4349 Proposing changes to documentation and JSON Schema
Added proposed documentation section explaining Numeric data object and also updated JSON schema to match changes.

I tested the numeric example with tap_action.data in the documented web editor. The current schema did not appear to reject the field,
likely because numeric tap_action does not currently forbid additional properties at that nested level. I still added data explicitly
to the numeric schema so it is documented, discoverable, and type-checked as an object.
2026-06-23 11:12:00 -04:00
StumblingGamer
b1fb5d9417 Preserve tap action data for numeric picker actions
Pass tap_action.data into numeric menu items and merge it with the selected picker value before calling the Home Assistant service.
2026-06-22 11:03:23 -04:00
Philip Abbey
2fb59d2a56 Update Actions.md
Main update is to point out the obvious that a PIN can only be used with touch screen enabled devices. Some additional tidying too.
2026-06-18 08:30:53 +01:00
6 changed files with 67 additions and 9 deletions

View File

@@ -256,6 +256,11 @@
"action": {
"$ref": "#/$defs/action"
},
"data": {
"type": "object",
"title": "Additional action data",
"description": "Fixed Home Assistant service data. The selected picker value is merged into this object using the picker's data_attribute. Service-specific fields cannot be schema checked here."
},
"picker": {
"type": "object",
"title": "Number picker configuration",

View File

@@ -25,6 +25,8 @@ Two simple examples using a scene and a cover as `tap` menu items.
}
```
## Confirmation
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.
```json
@@ -56,6 +58,8 @@ The `confirm` field may contain a string instead of a Boolean in order to provid
}
```
## Personal Identification Number (PIN)
**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.
@@ -70,9 +74,14 @@ The 4-digit PIN is set globally for all actions in the app settings in Connect I
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.
<img src="../images/pin_view.png" width="200" title="Confirmation View"/>
<img src="../images/pin_view.png" width="200" title="PIN View"/>
Note that for notify events, you _must_ not supply an `entity_id` or the API call will fail. There are other examples too.
> [!IMPORTANT]
> The PIN entry requires a touch screen enabled device.
## Additional Data
Some `action`s require additional `data` to be supplied. The following example shows how we handle this scenario. Note that for notify events, you _must not_ supply an `entity_id` or the API call will fail. There are other examples too.
```json
{

View File

@@ -39,6 +39,36 @@ Field | Purpose
It may well be the case that often `attribute` and `data_attribute` are the same attribute, as with this example.
## Additional Action Data
The `tap_action` object may also include a `data` object for fixed service call parameters. When the picker value is selected, the application merges the picker value into this `data` object using `data_attribute`.
For example, a light brightness picker can request a HomeAssistant transition while still using the picker value for `brightness`.
```json
{
"name": "Lounge Brightness",
"content": "{{ ((state_attr('light.lounge','brightness') | int(0) / 255) * 100) | round(0) }}%",
"type": "numeric",
"entity": "light.lounge",
"tap_action": {
"action": "light.turn_on",
"data": {
"transition": 2
},
"picker": {
"step": 5,
"min": 0,
"max": 255,
"attribute": "brightness",
"data_attribute": "brightness"
}
}
}
```
The resulting action data sent to HomeAssistant contains both the fixed `transition` value and the selected `brightness` value.
## Helper
You might define a "helper" entity as follows in HomeAssistant:

View File

@@ -163,6 +163,7 @@ class HomeAssistantMenuItemFactory {
entity_id as Lang.String?,
template as Lang.String?,
action as Lang.String?,
data as Lang.Dictionary?,
picker as Lang.Dictionary,
options as {
:exit as Lang.Boolean,
@@ -171,9 +172,12 @@ class HomeAssistantMenuItemFactory {
:icon as WatchUi.Bitmap
}
) as WatchUi.MenuItem {
var data = null;
if (entity_id != null) {
data = { "entity_id" => entity_id };
if (data == null) {
data = { "entity_id" => entity_id };
} else {
data["entity_id"] = entity_id;
}
}
var keys = mMenuItemOptions.keys();
for (var i = 0; i < keys.size(); i++) {

View File

@@ -155,7 +155,10 @@ class HomeAssistantNumericMenuItem extends HomeAssistantMenuItem {
//
function onConfirm(b as Lang.Boolean) as Void {
var dataAttribute = mPicker["data_attribute"] as Lang.String?;
var entity_id = mData["entity_id"] as Lang.String?;
var entity_id = null as Lang.String?;
if (mData != null) {
entity_id = mData["entity_id"] as Lang.String?;
}
WatchUi.popView(WatchUi.SLIDE_RIGHT);
WatchUi.requestUpdate();
@@ -164,12 +167,18 @@ class HomeAssistantNumericMenuItem extends HomeAssistantMenuItem {
return;
}
if (mAction != null) {
var data = {} as Lang.Dictionary;
if (mData != null) {
var keys = mData.keys();
for (var i = 0; i < keys.size(); i++) {
data[keys[i]] = mData[keys[i]];
}
}
data["entity_id"] = entity_id.toString();
data[dataAttribute.toString()] = mValue;
mHomeAssistantService.call(
mAction,
{
"entity_id" => entity_id.toString(),
dataAttribute.toString() => mValue
},
data,
mExit
);
}

View File

@@ -141,6 +141,7 @@ class HomeAssistantView extends WatchUi.Menu2 {
entity,
content,
action,
data,
picker,
{
:exit => exit,