Skip to content

Commit

Permalink
Markdown fixes
Browse files Browse the repository at this point in the history
Signed-off-by: Sebastian Schildt <sebastian.schildt@de.bosch.com>
  • Loading branch information
SebastianSchildt authored and erikbosch committed Jun 10, 2024
1 parent d8bc1c4 commit d5fdcfa
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 17 deletions.
26 changes: 13 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# KUKSA CAN Provider

![KUKSA Logo](./doc/img/logo.png)

This is a DBC CAN provider for the
Expand Down Expand Up @@ -49,35 +50,33 @@ Default values shall be provided by a JSON file, an example file exists in [dbc_

*By default only dbc2val-mode is enabled!*



## General Setup Requirements

1. Install can utils, e.g. in Ubuntu do:
Install can utils, e.g. in Ubuntu do:

```console
$ sudo apt update
$ sudo apt install can-utils
sudo apt update
sudo apt install can-utils
```

2. Check that at least Python version 3.9 is installed
Check that at least Python version 3.9 is installed

```console
$ python -V
python -V
```

3. Install the needed python packages
Install the needed python packages

```console
$ pip install -r requirements.txt
pip install -r requirements.txt
```

*Note - Sometimes DBC provider on main branch rely on a kuksa-client pre-release. Then you must add `--pre` to the command above!*

4. If you want to run tests and linters, you will also need to install development dependencies
If you want to run tests and linters, you will also need to install development dependencies

```console
$ pip install -r requirements-dev.txt
pip install -r requirements-dev.txt
```

## CAN Mapping
Expand All @@ -100,7 +99,6 @@ The KUKSA project publish the CAN provider as a Docker container.
Please see [CAN Provider Docker Setup](doc/docker.md) for more information on how to build and use
the CAN Provider as a Docker container.


## Provided can-dump and DBC files

CAN dump files are usable for test purposes. This repository contain two dump files which are used for testing and also used as basis for the examples in this repository.
Expand All @@ -110,7 +108,8 @@ is a CAN trace from 2018 Tesla M3 with software 2021.40.6.
This data is interpreted using the [Model3CAN.dbc](./Model3CAN.dbc) [maintained by Josh Wardell](https://github.com/joshwardell/model3dbc).

The canlog in the repo is compressed, to uncompress it (will be around 150MB) do
```

```console
unxz candump-2021-12-08_151848.log.xz
```

Expand All @@ -123,6 +122,7 @@ A smaller excerpt from the above sample, with fewer signals.
* [SAE-J1939 support](doc/j1939.md)

## Pre-commit set up

This repository is set up to use [pre-commit](https://pre-commit.com/) hooks.
Use `pip install pre-commit` to install pre-commit.
After you clone the project, run `pre-commit install` to install pre-commit into your git hooks.
Expand Down
7 changes: 3 additions & 4 deletions doc/docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,13 @@ docker run --net=host -e LOG_LEVEL=INFO can-provider:latest --server-type kuksa

A pre-built Docker container is available in the repository. The container is availablat the github container registry via

```
```console
docker pull ghcr.io/eclipse-kuksa/kuksa-can-provider/can-provider
```

For users where the ghcr regsitry is not easily accesible, e.g. China mainland users, starting from release 0.4.4 we also made the container images available at quay.io
If the ghcr registry is not easily accessible to you, e.g. if you are a China mainland user, starting from release 0.4.4 we also made the container images available at quay.io:

```
```console
docker pull quay.io/eclipse-kuksa/can-provider
```

Expand All @@ -41,7 +41,6 @@ when starting the container. Below is an example based on that the token file
is cloned to `/home/user/kuksa.val`. Then the token can be accessed by mounting the `jwt`folder using the `-v`
and specify `token=/jwt/provide-all.token` in the [default configuration file](../config/dbc_feeder.ini).


```console
docker run --net=host -e LOG_LEVEL=INFO -v /home/user/kuksa.val/jwt:/jwt can-provider:latest
```
Expand Down

0 comments on commit d5fdcfa

Please sign in to comment.