Skip to content

Commit 6165c91

Browse files
committed
Update Readme
1 parent 7f89e04 commit 6165c91

1 file changed

Lines changed: 8 additions & 3 deletions

File tree

README.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,12 @@
22

33
This component is part of the Starwit Awareness Engine (SAE). See umbrella repo here: https://github.com/starwit/vision-pipeline-k8s
44

5-
The intention of this stage is to write received SAE messages to a different redis/[valkey](https://valkey.io/) instance. This means data created by SAE can be transfered to a backend
5+
The intention of this stage is to write received messages to a different redis/[valkey](https://valkey.io/) instance. This means data created by SAE can be transfered to a backend.
6+
It transparently forwards all messages it receives, regardless of their type, to the configured Redis instance.
7+
If the configuration option `remove_frame_data` is set and the message sucessfully parses as a `SaeMessage`, all image data will be removed from the frame before forwarding the message.
68

79
The following features are planned:
810
- Aggregate all messages into a single output stream, therefore leaving it to the receiver to filter (this should be feasible, because messages without frame data are magnitudes smaller, see below)
9-
- Remove all frame data for privacy and volume reasons
1011

1112
## How to Build
1213

@@ -32,4 +33,8 @@ export DOCKER_HOST=unix:///run/user/$(id -u)/docker.sock
3233
export TESTCONTAINERS_DOCKER_SOCKET_OVERRIDE=/run/user/$(id -u)/docker.sock
3334
```
3435

35-
If you want to run the tests through VSCode you have to run the action `Python: Configure Tests` and select `pytest`. The Variables above can be supplied by putting an `.env` file into the project root directory.
36+
If you want to run the tests through VSCode you have to run the action `Python: Configure Tests` and select `pytest`. The Variables above can be supplied by putting an `.env` file into the project root directory.
37+
38+
## Changelog
39+
### 1.5.0
40+
- Now transparently forwards all messages verbatim, except if `SaeMessage` is detected for a given stream. No configuration change necessary for existing installations.

0 commit comments

Comments
 (0)