Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add details discovered in running locally #43

Merged
merged 2 commits into from
May 20, 2022
Merged

docs: add details discovered in running locally #43

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3d24f25
docs: add details discovered in running locally
danielgordon-switch-ev May 18, 2022
9ff4e62
docs: clarify network interface explanation
danielgordon-switch-ev May 19, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 26 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ The primary dependencies to install the project are the following:

> - Linux Distro (Non-Linux Systems are not supported)
> - Poetry [^3]
> - Python >= 3.7
> - Python >= 3.9

There are two recommended ways of running the project:

Expand Down Expand Up @@ -51,6 +51,26 @@ Option 2. Local Installation
The JRE engine is only a requirement in Josev Community if using the Java-based
EXI codec (EXIficient)[^4]. Josev Professional uses our own Rust-based EXI codec.

In Ubuntu, the default version of Java installed by your distribution may not be recent enough.
If so, you can manually install a more recent version of Java and configure it to
be the default:

```bash
sudo apt install openjdk-17-jre
```

Display the different installed versions of Java you have installed:
```bash
update-alternatives --query java
```

Configure the more recent version to be the default:
```bash
update-alternatives --config java
```

Then follow the instructions to configure your desired version.

Comment on lines +72 to +73
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for adding these detailed instructions, Daniel. Also, as users are likely to try and start execute the code before reading through the entire document, do you think it would help to point out the .env settings here, right after the java update instructions? A comment suggesting - "Configure .env file as suggested here (https://github.com/SwitchEV/iso15118#environment-settings)" would suffice?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's definitely something I have in mind for my next PR -- to rearrange the existing information so that people are presented with what they need to get up and running right away. I thought it might be simpler to add the additional instructions first, then restructure the document in a second PR, since both together could be hard to follow.

For convenience, the Makefile, present in the project, helps you to start up SECC. Thus, in the terminal run:

```bash
Expand Down Expand Up @@ -130,6 +150,10 @@ it is required to create a `.env` file, containing the required settings.
This means, if development settings are desired, one can simply copy the contents
of `.env.dev.local` to `.env`.

By default, `.env.dev.local` assumes the presence of an `eth0` network interface.
If you are not using eth0 as your network interface, replace the `NETWORK_INTERFACE` value
in your local `.env` file with the one you are using.

If Docker is used, the command `make run` will try to get the `.env` file;
The command `make dev` will fetch the contents of `.env.dev.docker` - thus,
in this case, the user does not need to create a `.env` file, as Docker will
Expand All @@ -153,7 +177,7 @@ $ make run-evcc
This integration test was tested under:

- Linux - Ubuntu and Debian distros
- MacOs
- MacOS

[^1]: https://www.iso.org/standard/55366.html
[^2]: https://www.switch-ev.com/news-and-events/new-features-and-timeline-for-iso15118-20
Expand Down