symphony-example

Running the Example

1. Make sure that you have installed Docker Compose on your workstation.
2. Run the following command:

   docker compose up -d

This will build the example ECU Updater binary as a container image and start it up together with a Symphony API server.

classDiagram
direction LR

class Client
<<actor>> Client
class SymphonyAPI
<<component>> SymphonyAPI
class EcuUpdater
<<component>> EcuUpdater
class TargetProvider {
    get()
    update()
    delete()
}
<<interface>> TargetProvider

Client --> SymphonyAPI
SymphonyAPI --> TargetProvider
TargetProvider <|.. EcuUpdater

Loading

A client uses the Symphony API server's HTTP interface to manage Symphony entities like Targets, Solutions etc. The Symphony API server invokes Target Provider operations on the ECU Updater to manage the state of components being deployed.

Deploying Firmware to ECUs via Symphony

The Symphony API server allows clients to deploy software Components to Targets. The targets are logical representations of the runtime environments for the software like an operating system, a particular device or a Kubernetes cluster. In this example, the ECUs are represented by the ECU Updater target.

The exampe implementation simply maintains the deployment state in memory and prints corresponding messages to the console. In a real world implementatoin, the updater could use the UDS protocol to actually flash the ECUs with the firmware images.

1. To trigger the installation/update:

   ./trigger_ecu_update.sh

   This will transfer the example target definition to the Symphony API server and instruct it to deploy two firmware components to the ECU Updater target.

2. The ECU Updater component will receive a corresponding update command and install the two firmware images. The log file will contain corresponding messages:

   docker logs ecu-updater