6.1. edm

edm stands for EVerest dependency manager. It helps you orchestrating the dependencies between the different EVerest repositories.

6.1.1. Dependency Manager for EVerest

6.1.1.1. Install and Quick Start

To install the edm dependency manager for EVerest you have to perform the following steps.

Please make sure you are running a sufficiently recent version of Python3 (>=3.6) and that you are able to install Python packages from source. See the python3 command below for upgrading the required packages. Refer to the Python Installing Packages documentation for indepth guidance if any problems arise.

python3 -m pip install --upgrade pip setuptools wheel jstyleson jsonschema

6.1.1.2. Installing edm

Now you can clone this repository and install edm:

A script for the steps below can be found here.

git clone https://github.com/EVerest/everest-dev-environment
cd everest-dev-environment/dependency_manager
python3 -m pip install .
edm init --workspace ~/checkout/everest-workspace

The last command creates a workspace in the ~/checkout/everest-workspace directory from the most recent release of EVerest. If you want the most recent main you can use:

edm init main --workspace ~/checkout/everest-workspace

The workspace will have the following structure containing all current dependencies for EVerest:

everest-workspace/
├── everest-core
├── everest-deploy-devkit
├── everest-dev-environment
├── everest-framework
├── everest-utils
├── liblog
├── libmodbus
├── libocpp
├── libsunspec
├── libtimer
├── open-plc-utils
├── RISE-V2G
└── workspace-config.yaml

The workspace-config.yaml contains a copy of the config that was used to create this workspace.

6.1.1.3. Enabling CPM_SOURCE_CACHE and setting PATH

The EVerest dependency manager uses CPM for its CMake integration. This means you can and should set the CPM_SOURCE_CACHE environment variable. This makes sure that dependencies that you do not manage in the workspace are not re-downloaded multiple times. For detailed information and other useful environment variables please refer to the CPM Documentation.

Also set the PATH variable:

export CPM_SOURCE_CACHE=$HOME/.cache/CPM
export PATH=$PATH:/home/$(whoami)/.local/bin

6.1.1.4. Building EVerest

Make sure you have installed ev_cli first. You can now use the following commands to build the repository everest-core:

cd ~/checkout/everest-workspace/everest-core
mkdir build
cd build
cmake ..
make install

6.1.1.5. Python packages needed to run edm

The following Python3 packages are needed to run edm. If you installed edm using the guide above they were already installed automatically.

  • Python >= 3.6

  • Jinja2 >= 3.0

  • PyYAML >= 5.4

6.1.2. Setting up and updating a workspace

For letting edm do the work of setting up an initial EVerest workspace, do this:

edm init --workspace ~/checkout/everest-workspace

If you are currently in the everest-workspace directory the following command has the same effect:

edm init

Advanced users would eventually want to use their customized lib versions or branches of repos. This can be achieved by editing the workspace-config.yaml file in the root of the workspace. An edm init will setup your current workspace accordingly.

6.1.3. Using the edm CMake module and dependencies.yaml

To use edm from CMake you have to add the following line to the top-level CMakeLists.txt file in the respective source repository:

find_package(EDM REQUIRED)

To define dependencies you can now add a dependencies.yaml file to your source repository. It should look like this:

---
liblog:
  git: https://github.com/EVerest/liblog
  git_tag: main
  options: ["BUILD_EXAMPLES OFF"]
libtimer:
  git: https://github.com/EVerest/libtimer
  git_tag: main
  options: ["BUILD_EXAMPLES OFF"]

6.1.4. Create a workspace config from an existing directory tree

Suppose you already have a directory tree that you want to save into a config file. You can do this with the following command:

edm --create-config custom-config.yaml

This is a short form of:

edm --create-config custom-config.yaml --include-remotes https://github.com/EVerest/*

and only includes repositories from the EVerest namespace. You can add as many remotes to this list as you want.

For example, if you only want to include certain repositories you can use the following command.

edm --create-config custom-config.yaml --include-remotes https://github.com/EVerest/everest* https://github.com/EVerest/liblog.git

If you want to include all repositories, including external dependencies, in the config you can use the following command:

edm --create-config custom-config.yaml --external-in-config

6.1.5. Git information at a glance

You can get a list of all git repositories in the current directory and their state using the following command:

edm --git-info --git-fetch

If you want to know the state of all repositories in a workspace you can use the following command:

edm --workspace ~/checkout/everest-workspace --git-info --git-fetch

This creates output that is similar to the following example:

[edm]: Git info for "~/checkout/everest-workspace":
[edm]: Using git-fetch to update remote information. This might take a few seconds.
[edm]: "everest-dev-environment" @ branch: main [remote: origin/main] [behind 6] [clean]
[edm]: "everest-framework" @ branch: main [remote: origin/main] [dirty]
[edm]: "everest-deploy-devkit" @ branch: main [remote: origin/main] [clean]
[edm]: "libtimer" @ branch: main [remote: origin/main] [dirty]
[edm]: 2/4 repositories are dirty.

Further information can be seen as shell output by calling edm with parameter -h or –help.