leosperry/ha-kafka-net

Integration that uses Home Assistant Kafka integration for creating home automations in .NET and C#

ha-kafka-net's Issues

HaApiProvider does not use settings object in lightTurnOn

Expectation is that properties should pass to HA.

Potentially, a new model could be used here.

Add endpoint for retrieving automation info

Cannot construct Scheduled automations with automation builder.

There are a few missing methods that must be implemented.

Workaround: Use IAutomationFactory instead of IAutomationBuilder.

Handle when a conditional automation is disabled and delayed task is already set up

Create Trace Data Object

We need an object for tracking trace data. It should include:

• Timestamp
• Link to automation
• Action that was taken (e.g. trigger or delayed execution)
• Log data
• Data that was passed to automation

Update UI to use `Key` instead of `Id`

Add lookup by key to Automation Manager

V5 features will need a way to look up an automation by key

Acceptance Criteria

• Enforce Key uniqueness at initialization
• Add method for retrieving

Add AdditionalEntitiesToTrack to AutomationBuilder

Add `Enabled` property to `IAutomation`

New Automation Specific UI

Create a new view in the UI for rendering information about a specific automation

Data to list

• Information about the automation itself
  • Key
  • Name
  • Description
  • Trigger IDs
  • Additional IDs
• Last run data

To be added in a later story

• Logs
• Trace Data

Deprecate `Id` field on automation metadata

Add a button on the dashboard for executing conditional automations immediately.

Prebuilt Durable auto on/off events not triggering

At restart, the Old and New values of a state change can be the same if the event being handled is the same as last cached.

In the case of DurableAutoOff, this means that TurnedOn() will return false because it is trying to check old versus new, and at this point in time, the actual Old is gone. Both states could be saying "on". So, the code is not saying that it turned or changed from off to on.

Options:

• Don't have DurableAutoOff check Old. Instead only check if it is currently on.
• Future version possibility: have the cache also cache the previous for this case.

Fix coming today.

Add Conditional Automation execution to System Monitor

Add Web front end

Add Post for Enabling/Disabling automation

Handle Power Failure

After a power outage, if HA comes back online before the kafka instance, HA will not load the integration.

Unfortunately, HA does not expose state of inetgrations via API.

We might be able to check the logs, but they are not clear. Example HA log:

2024-02-06 07:54:05.161 ERROR (MainThread) [homeassistant] Error doing job: Task exception was never retrieved
Traceback (most recent call last):
  File "/usr/src/homeassistant/homeassistant/components/apache_kafka/__init__.py", line 152, in write
    await self._producer.send_and_wait(self._topic, payload)
  File "/usr/local/lib/python3.11/site-packages/aiokafka/producer/producer.py", line 461, in send_and_wait
    future = await self.send(
             ^^^^^^^^^^^^^^^^
  File "/usr/local/lib/python3.11/site-packages/aiokafka/producer/producer.py", line 444, in send
    key_bytes, value_bytes = self._serialize(topic, key, value)
                             ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/usr/local/lib/python3.11/site-packages/aiokafka/producer/producer.py", line 349, in _serialize
    self._producer_magic)
    ^^^^^^^^^^^^^^^^^^^^
AttributeError: 'AIOKafkaProducer' object has no attribute '_producer_magic'

Expected Behavior:
If we can confirm kafka integration is down or no events are streaming to kafka for configurable amount of time, restart home assistant which can be done with a service call.

Update State manager to only fire automation if enabled

Add `Name` property to `IAutomation`

This should be a non-breaking change where the name defaults to the type name

Add System Monitor to Test Harness

Save Trace Data to cache

Capture Log data

We need a way to capture log data and add it to trace data

Add Enable/Disable switch for automations

Add key field

Currently, the UI uses a GUID that is randomly generated and changes every time the application loads. This is not usable for persisting any kind of state.

Acceptance Criteria:

• Add a human readable key field that is procedurally generated if not provided by the user.

Render Trace Data in UI

On the automation page, list out the trace data

Deliver Web Content in nuget

Add grid for displaying automations

Should Display

• Type
• Name
• Trigger Entity IDs
• Last triggered (extended goal)

React UI improvements

Currently there is a single react component which handles a nested data structure.
It would be nice to have smaller react components.

Use ManifestEmbeddedFileProvider for web files.

This may be a way to hide non-editable files from consumers of the nuget package

Factory DurableAutoOffOnEntityOff() non functional

Work-around: use LightOffOnNoMotion() instead.

Update Automation Builder to enable setting Key Request

Null DateTime? State properties

When a state is converted to any HaEntityState<DateTime?, T>, the State is converting correctly.

Workaround:
Parse the date before converting from string.

Generate Trace Data in memory

Hook into the automation pipeline and create trace data

Add feature for alerting on non-reporting entities