Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history 
Omni to OmnAI
  • Loading branch information
@AKMaily
AKMaily authored Dec 2, 2024
1 parent f51d309 commit 86b0b08
Showing 1 changed file with 21 additions and 21 deletions.
42 changes: 21 additions & 21 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@

![example workflow](https://github.com/skunkforce/omniview/actions/workflows/build.yaml/badge.svg)
# OmniView
OmniView is an experimental GUI for the measurement-devices of the research-collaboration AW4null.
It's purpose is the display and the handling of data, generated by [Auto-Intern OmniScopes](https://www.auto-intern.de/shop/).
![example workflow](https://github.com/skunkforce/omnaiview/actions/workflows/build.yaml/badge.svg)
# OmnAIView
OmnAIView is an experimental GUI for the measurement-devices of the research-collaboration AW4null.
It's purpose is the display and the handling of data, generated by [Auto-Intern OmnAIScopes](https://www.auto-intern.de/shop/).


## Planned functionality
The plan of AW4null is to enhance car-diagnostics with AI-powered diagnostic-services.
Diagnostic-services will be reachable through differen REST-APIs and will be specialized on a lot of different purposes.
Physical-measurements of automotive-sensors will be taken, displayed in OmniView and send to an API at the users will.
OmniView shall receive data from multiple generators, such as OmniScopes and OmniB-, OmniE-Clamp and OmniPressure.
Physical-measurements of automotive-sensors will be taken, displayed in OmnAIView and send to an API at the users will.
OmnAIView shall receive data from multiple generators, such as OmnAIScopes and OmnAIB-, OmnAIE-Clamp and OmnAIPressure.
The data will come in as a binary stream of 24-bit integers.
Since the incoming data represents measurement-samples in the time-domain, the individual channels will be synchronized.
This is done in a currently non-public-repo of Auto-Intern, but will be separated into a `.dll` or `.so` respectively.
The acquired data can be viewed on the OmniView GUI and may then be saved to the hard-drive in `.csv` or binary format.
The acquired data can be viewed on the OmnAIView GUI and may then be saved to the hard-drive in `.csv` or binary format.
Anyhow, another possibility is to send the measurement to a REST-API provided by the [THGA](https://www.thga.de).

### Phase One Development
Expand All @@ -22,18 +22,18 @@ The API will be able to receive training-data for AI-training purposes.

### Phase Two Development
Phase two will implement the interface to the data-producer as a `vector` of a multitude of objects, that encapsulate each an individual `.dll` or `.so`.
The first two shared libs that shall be used will be a software-function-generator as well as an abstraction of the OmniScope, following the _Unified-abstract-Dataproducer-Interface_ which is displayed in the [UaDI-Demonstrator-Repo](https://github.com/skunkforce/Unified-Dataproducer-Interface-Demonstrator).
The first two shared libs that shall be used will be a software-function-generator as well as an abstraction of the OmnAIScope, following the _Unified-abstract-Dataproducer-Interface_ which is displayed in the [UaDI-Demonstrator-Repo](https://github.com/skunkforce/Unified-Dataproducer-Interface-Demonstrator).

### Phase Three Development
In phase three, OmniView will be extended to use a multitude of service-APIs that can be loaded at runtime.
In phase three, OmnAIView will be extended to use a multitude of service-APIs that can be loaded at runtime.
![Architecture Diagram](https://lucid.app/publicSegments/view/113f9581-f43f-435a-a36d-6f9e0276adec/image.png)

# Building OmniView
Building is currently only possible with specially provided access-rights, but will be made available to the wider public as soon as the migration to a closed-source shared-library for device handling has been done as described in [Issue #36](https://github.com/skunkforce/omniview/issues/36).
# Building OmnAIView
Building is currently only possible with specially provided access-rights, but will be made available to the wider public as soon as the migration to a closed-source shared-library for device handling has been done as described in [Issue #36](https://github.com/skunkforce/omnaiview/issues/36).
In order to ask for access-rights, contact [@bjoekeldude](https://github.com/bjoekeldude).


Anyhow, building __IS__ available in CI. A push into any branch will generate a new binary, that can be downloaded via the [Action-Tab](https://github.com/skunkforce/omniview/actions).
Anyhow, building __IS__ available in CI. A push into any branch will generate a new binary, that can be downloaded via the [Action-Tab](https://github.com/skunkforce/omnaiview/actions).


Building requires `cmake --version > 3.20` as well as a `c++20`-Compiler.
Expand All @@ -57,7 +57,7 @@ In order to start the compilation, following packages need to be ensured:
* libglu1-mesa-dev
* pkg-config
### Compile
Move into OmniView-directory, update and initialize all submodules:
Move into OmnAIView-directory, update and initialize all submodules:
```shell
git submodule update --init --recursive
```
Expand All @@ -72,7 +72,7 @@ Start the compilation by using the CMake-command:
cmake --build .
```

In order to run OmniView it needs admin-rights right now:
In order to run OmnAIView it needs admin-rights right now:
```shell
sudo ./OmniView
```
Expand Down Expand Up @@ -111,8 +111,8 @@ This starts a Session with all env-variables set accordingly.

Run the following commands in the Developer Command Prompt:
```shell
git clone --recurse-submodules [email protected]:skunkforce/OmniView.git
cd OmniView
git clone --recurse-submodules [email protected]:skunkforce/OmnAIView.git
cd OmnAIView
cmake -S . -B ./build -DVCPKG_TARGET_TRIPLET="x64-windows-static"
cmake --build ./build --config Release
```
Expand Down Expand Up @@ -144,7 +144,7 @@ However, they should only be used when necessary because the code should not be

The different PlotRegions have namespaces for readability: SideBarRegion, DevicesRegion, ToolbarRegion, and PlotRegion.

The design and usage of the Regions can be found in the skunkforce/OmniView-Product-Vision Document.
The design and usage of the Regions can be found in the skunkforce/OmnAIView-Product-Vision Document.

# Workflow: Adding new Code

Expand All @@ -165,9 +165,9 @@ To add new code to the project, follow these steps:

To use the Clang-Formatter, follow these steps:

1. Navigate to your /OmniView folder.
1. Navigate to your /OmnAIView folder.
2. Check if you have Clang-Formatter installed on your system.
3. If Clang-Formatter is installed, use the following command in the /OmniView directory to format the desired file:
3. If Clang-Formatter is installed, use the following command in the /OmnAIView directory to format the desired file:

```shell
clang-format -style=file -i directory/filetochange
Expand Down Expand Up @@ -199,9 +199,9 @@ Version numbers for software releases follow a standard format,

```
git clone [email protected]:skunkforce/OmniView.git
git clone [email protected]:skunkforce/OmnAIView.git
cd OmniView
cd OmnAIView
git tag vNUMBER
Expand Down

0 comments on commit 86b0b08

Please sign in to comment.