Add param support on helper functions

maxlyth commented 3 years ago

Add param support to helper functions

It seems illogical that param support is specifically unavailable when calling helper functions. This makes it impossible to use a generic script that handles motion where multiple EntityControllers can pass a differentiating parameter to that script. An example might be to pass the room name to the helper function and to the script which could in turn initiate a scene using the same parameter.

Code changes

Modification is restricted to handleTriggerOnDeactivateEntities and handleTriggerOnActivateEntities functions. These functions should be consistent in param handling and effectively the same changes are applied to both

Configuration

  trigger_on_activate: script.room_lights_motion
  trigger_on_deactivate: script.room_lights_off
  service_data:
    variables:
      room: "bedroom"
  service_data_off:
    variables:
      room: "bedroom"

Checklist

[x] The PR title is clear, concise and follows conventional commit formatting.
[x] Double-check your branch is based on develop and targets develop
[x] Issue raised to compliment this PR (if no pre-existing issue exists)
[x] Code is commented, particularly in hard-to-understand areas and relevant issues are referenced.
[x] Documentation repository updated to reflect new features or changes in behaviour (VERY IMPORTANT, undocumented features cannot be discovered and used!)
[x] Description explains the issue/use-case resolved and auto-closes related issues.
[x] Breaking changes or changes in behaviour are called out and discussed in separate issues.
[x] Testing of new changes completed by person who raised the issue.

Related Issues

Param support in Helper Functions #249

Closes

danobot commented 3 years ago

Merge in the latest from develop branch. Happy to take a look. You're right it is illogical which makes me think there must be a reason I specifically didnt pass parameters along.

maxlyth commented 2 years ago

This seems to have stagnated so I have added a concrete example to the documentation in Doc Pull request #4 https://github.com/danobot/ec-docs/pull/4

danobot commented 2 years ago

Thank you for your contribution

danobot / entity-controller