Skip to content

Commit c4e6942

Browse files
authored
Update README.md
1 parent f844578 commit c4e6942

File tree

1 file changed

+5
-25
lines changed

1 file changed

+5
-25
lines changed

apps/object_alert_app/README.md

+5-25
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,26 @@
1-
# Example Application
1+
# Object Alert app
22

3-
The Example App show how data from the vehicle can be received by an application running in the vehicle.
3+
The App show how data from the vehicle's camera is used to identify the region of interest and if objects identified within that region of interest then a warning is issued.
44

55
## Build
66

7-
When running `restart-shift2sdv`, or explicitly the `build-apps` script, the Example App will be build and containerized automatically as `ghcr.io/eclipse-sdv-hackathon-chapter-two/shift2sdv/example_app:latest`.
7+
When running `restart-shift2sdv`, or explicitly the `build-apps` script, the Example App will be build and containerized automatically as `ghcr.io/eclipse-sdv-hackathon-chapter-two/shift2sdv/object_alert_app:latest`.
88

99
Of course, you are free to build manually if needed by calling the following command from the example_app folder:
1010

1111
```shell
1212
podman build -t example_app:latest .
1313
```
1414

15-
**Note:** Inside the test-vehicle the Example App will run on ARM-Platform. Test the build by running the command above and ask the hack coaches to build your image for ARM to run it inside the test vehicle.
16-
17-
## Running
18-
19-
The Example App is automatically started by Ankaios as there is an entry for it in the [shift2sdv_manifest.yaml](shift2sdv_manifest.yaml).
20-
21-
In the test vehicle the Example App container image will be started and managed by Eclipse Ankaios.
22-
23-
Talk to the hack coaches to build a multi-platform or ARM image before trying to run the app in the vehicle.
24-
25-
## Development
26-
2715
### Run
2816

2917
Start the app inside the devcontainer for local development:
3018

3119
```shell
32-
python3 example_app.py
20+
python3 object_alert_app.py
3321
```
3422

35-
### Testing with mock data
36-
37-
Ask the hack coaches for an eCAL recording to play back a recorded driving scenario with eCAL and to receive the vehicle dynamics data in the Example App for development.
23+
### Testing with Sample data
3824

3925
Place the downloaded eCAL recording in a `measurements/` folder next to the current file.
4026

@@ -44,12 +30,6 @@ Start the eCAL recording within the devcontainer, replace `<recording_folder>` w
4430
ecal_play -m measurements/<recording_folder>
4531
```
4632

47-
Start the Example App inside the devcontainer as shown above.
48-
49-
You should see logs of the JSON data received, and in the web browser the tachometer should show some speed values.
50-
51-
For debugging reasons you can start the eCAL Monitor terminal UI in a separate terminal window by running:
52-
5333
```shell
5434
ecal_mon_tui
5535
```

0 commit comments

Comments
 (0)