Configuration rework (#19)

* Configuration rework (using Viper)

* Docker fixes

Author: xBlaz3kx

.github/workflows/testing.yaml

@@ -21,7 +21,7 @@ jobs:
           go-version: "^1.17"
 
       - name: Build
-        run: go build --tags=dev -v  ./...
+        run: go build --tags=dev .
 
       - name: Test
-        run: go test --short --tags=dev -v ./...
+        run: go test --short --tags=dev -v ./...

ReadMe.md

@@ -10,9 +10,7 @@ requires installation of a few C libraries.
 ChargePi-go client can be deployed/run in multiple ways:
 
 - standalone
-- Docker 🐳 by building the image and running the container
-- Docker-compose with SteVe Central System and Watchtower (**recommended for testing only**)
-- Docker-compose (client only)
+- Docker 🐳 and docker-compose
 
 ## 🔌 Charge point specifications
 
@@ -28,8 +26,10 @@ default settings which require minimal configuration.
 
 ### 📑 Logging
 
-ChargePi supports multiple logging outputs. Configure the `logging` property in the [settings](/configs/settings.json)
-file. Check out the list below:
+Debugging and insight of the charge point made simple. ChargePi supports multiple logging outputs specifying the format
+the [settings](/configs/settings.json) file.
+
+Supported formats:
 
 |            Logging type             | Supported |
 |:-----------------------------------:|:---------:|
@@ -41,38 +41,14 @@ For details, check out the [logging](/docs/logging/logging.md) docs.
 
 ## ⚡ Quickstart
 
-1. If you want to run SteVe on the same host (_Not recommended in production_):
-
-   ```bash
-   git clone https://github.com/RWTH-i5-IDSG/steve
-   ```
-
-   Replace SteVe's default Dockerfile with Dockerfile provided [here](build/SteVe/Steve.Dockerfile) to run on
-   Raspberry Pi.
+1. Wire your hardware according to the provided [schematics](/docs/hardware/hardware.md).
 
-2. Wire your hardware according to the provided [schematics](/docs/hardware/hardware.md).
+2. Install the [libraries](/docs/client/installing-libraries.md) (if needed).
 
-3. Install the [libraries](/docs/client/installing-libraries.md) (if needed).
-
-4. Configure the settings files according to the hardware and desired functionality:
+3. Configure the settings files according to the hardware and desired functionality:
     - [client configuration](/docs/client/configuration.md)
     - [OCPP configuration](/docs/ocpp/ocpp-16.md)
 
-5. Run the client.
-
-## 🏃 Running standalone
-
-Running the client:
-
-   ```bash
-   go run .
-   ```
-
-or compiling and executing the client:
-
-   ```bash
-   go build -o chargepi .
-   ./chargepi
-   ```
+4. Run the client.
 
-More options available in the [client startup guide](docs/client/running-the-client.md).
+Details on how to run the client are described in the [client startup guide](docs/client/running-the-client.md).

build/package/Dockerfile

@@ -1,43 +1,37 @@
-FROM  golang:1.17-alpine as base
+FROM  golang:1.17 as base
 
-RUN apt-get update \
-    apt-get upgrade \
-    apt-get install git \
-    apt-get install cmake \
+COPY . /ChargePi/src
+WORKDIR /ChargePi/src
 
-# Install dependencies
-COPY ../../docs/install-dependencies.sh ~/
-RUN chmod +x /install-dependencies.sh
-RUN ./install-dependencies.sh 0
+ARG READER_CONNECTION_TYPE
+ENV READER_CONNECTION_TYPE=$READER_CONNECTION_TYPE
 
-COPY ../.. /ChargePi/src
-WORKDIR /ChargePi/src
+# Install dependencies
+RUN chmod +x ./scripts/install-dependencies.sh
+RUN ./scripts/install-dependencies.sh $READER_CONNECTION_TYPE 0
 
 # Compile the client
-RUN cd ~
-RUN go build -o ChargePi .
+RUN go mod download
+RUN go mod verify
+RUN go build -tags="rpi" -o ChargePi .
 
 FROM base as dev
-ENTRYPOINT ["go","run","."]
+ENTRYPOINT ["go","run", "-tags=rpi","."]
 
 FROM alpine as chargepi
 
-# Reinstall the dependencies because the image is alpine
-RUN apt-get update \
-    apt-get upgrade \
-    apt-get install git \
-    apt-get install cmake \
+WORKDIR /etc/ChargePi
+
+ARG READER_CONNECTION_TYPE
+ENV READER_CONNECTION_TYPE=$READER_CONNECTION_TYPE
 
 # Install dependencies
-COPY ../../docs/install-dependencies.sh ~/
-RUN chmod +x /install-dependencies.sh
-RUN ./install-dependencies.sh 0
+RUN chmod +x ./scripts/install-dependencies.sh
+RUN ./scripts/install-dependencies.sh $READER_CONNECTION_TYPE 0
 
 COPY --from=base /ChargePi/src/configs /etc/ChargePi/configs
 COPY --from=base /ChargePi/src/ChargePi /usr/bin/ChargePi
 
-WORKDIR /etc/ChargePi
-
 ENTRYPOINT ["./chargepi"]
 
 # Test the client
@@ -46,4 +40,4 @@ RUN cp -r configs/ test/  \
     && cd test/  \
     && chmod +x create-test-certs.sh \
     && ./create-test-certs.sh \
-CMD ["go", "test","-v"]
+CMD ["go", "test","-v", "-tags=dev" ,"./..."]

deployments/docker-compose.steve.yaml

@@ -17,7 +17,7 @@ services:
         ipv4_address: 172.0.1.120
   steve:
     build:
-      dockerfile: ../build/SteVe/Steve.Dockerfile
+      dockerfile: ./build/SteVe/Steve.Dockerfile
       context: ..
     volumes:
       - ./steve:/code

deployments/docker-compose.yaml

@@ -7,24 +7,8 @@ services:
       target: chargepi
     restart: always
     volumes:
-      - /configs/:/ChargePi/configs/
-    labels:
-      - "com.centurylinklabs.watchtower.enable=true" # change to false if you do not wish to get automatic updates
+      - ./configs/:/ChargePi/configs/
     devices:
       - /dev/ttyAMA0:/dev/ttyAMA0
       - /dev/mem:/dev/mem
-    privileged: true
-    networks:
-      ocpp_network:
-        ipv4_address: 172.0.1.124
-  watchtower:
-    image: containrrr/watchtower:latest
-    volumes:
-      - /var/run/docker.sock:/var/run/docker.sock
-volumes:
-  chargepi:
-networks:
-  ocpp_network:
-    ipam:
-      config:
-        - subnet: 172.0.1.0/24
+    privileged: true

docs/client/configuration.md

@@ -1,15 +1,37 @@
 # 🛠️ Configuration
 
+## 🚩 Flags and environment variables
+
+Available flags:
+
+|        Flag         | Short |           Description           | Default value |
+|:-------------------:|:-----:|:-------------------------------:|:-------------:|
+|     `-settings`     |   /   |   Path to the settings file.    |               |
+| `-connector-folder` |   /   |  Path to the connector folder.  |               |
+|   `-ocpp-config`    |   /   | Path to the OCPP configuration. |               |
+|       `-auth`       |   /   | Path to the authorization file. |               |
+|      `-debug`       | `--d` |           Debug mode            |     false     |
+|       `-api`        | `--a` |         Expose the API          |     false     |
+|   `-api-address`    |   /   |           API address           |  "localhost"  |
+|     `-api-port`     |   /   |            API port             |     4269      |
+
+Environment variables are created automatically thanks to [Viper](https://github.com/spf13/viper) and are prefixed
+with `CHARGEPI`. Only the settings (not the ocpp configuration or connectors) are bound to the env
+variables. Debug mode and API settings flags are also bound to the environment variables.
+
+Example environment variable: `CHARGEPI_CHARGEPOINT_INFO_ID`.
+
+## 🛠 Configuration files
+
 There are three **required** configuration files:
 
 1. [`settings`](../../configs/settings.json)
 2. [`configuration`](../../configs/configuration.json)
 3. [`connector`](../../configs/connectors/connector-1.json)
 
-The settings files are supported in `YAML`, `JSON` or `TOML` format. All files must be only in one format. The format is
-configurable though program flags.
+The settings files are supported in `YAML`, `JSON` or `TOML` format.
 
-## The `settings` file
+### The `settings` file
 
 The `settings` file contains basic information about the charge point and provides connectivity details:
 
@@ -95,7 +117,7 @@ Example settings:
 }
 ```
 
-## 🔌 The `connector` file(s) - EVSEs and connectors
+### 🔌 The `connector` file(s) - EVSEs and connectors
 
 EVSE and connector settings files can be found in the `connectors` folder. To add and configure the connector, simply
 add a new file that contains the structure, defined in [attributes](#attributes) and modify it to your specs. The client
@@ -104,7 +126,7 @@ will scan the folder at boot and configure the connectors from the files if all
 Note: A Charge point can have multiple EVSEs, each oh which can have multiple connectors, but only one connector of the
 EVSE can charge at a time.
 
-### Attributes
+#### Attributes
 
 `Connector` object contains a connector type and an ID of the connector, which must start with 1 and increment by one.
 The status attribute changes according to the OCPP specification. The `session` represents a Charging session and is

docs/client/installing-libraries.md

@@ -5,10 +5,10 @@
 The process of installing the dependencies was automated by creating a [script](../install-dependencies.sh) for
 installing the necessary dependencies. The script has the following arguments:
 
-| Argument | Default value |                                                 Description                                                 |
-|:--------:|:-------------:|:-----------------------------------------------------------------------------------------------------------:|
-|    0     |  "pn532_i2c"  | The libnfc configuration for PN532 RFID card reader. Possible values are: pn532_uart, pn532_i2c, pn532_spi. |
-|    1     |   false (0)   |                      Whether or not to install Go on the system using a shell script.                       |
+| Argument | Default value |                                                    Description                                                    |
+|:--------:|:-------------:|:-----------------------------------------------------------------------------------------------------------------:|
+|    0     |  "pn532_i2c"  | The libnfc configuration for PN532 RFID card reader. Possible values are: `pn532_uart`, `pn532_i2c`, `pn532_spi`. |
+|    1     |   false (0)   |                         Whether or not to install Go on the system using a shell script.                          |
 
 Example usage:
 

docs/client/running-the-client.md

@@ -1,37 +1,26 @@
 # 🏃 Running the client
 
+This guide assumes you already have a working OCPP management/central system. If you do not have one already,
+check out [SteVe](https://github.com/RWTH-i5-IDSG/steve) and set it up according to their guide.
+
 ## Standalone
 
-This client uses **[SteVe](https://github.com/RWTH-i5-IDSG/steve)** for the Central System, but can connect to other
-Central Systems as well. Before you run/connect the client, make sure the backend is available and the charge point is
-registered.
+Before you run/connect the client, make sure the backend is available and the charge point is
+registered. Also, **libnfc** should be installed (a convenience script is available).
 
-1. Running the program in Golang:
+Running the client:
 
    ```bash
-   go run .
+   go run -tags=rpi .
    ```
 
-2. Compiling and executing the program:
+or compiling and executing the client:
 
    ```bash
-   go build -o chargepi .
+   go build -tags=rpi -o chargepi .
    ./chargepi
    ```
 
-### 🚩 Client flags/options
-
-|        Flag         | Short |           Description           | Default value |
-|:-------------------:|:-----:|:-------------------------------:|:-------------:|
-|     `-settings`     |   /   |   Path to the settings file.    |               |
-| `-connector-folder` |   /   |  Path to the connector folder.  |               |
-|   `-ocpp-config`    |   /   | Path to the OCPP configuration. |               |
-|       `-auth`       |   /   | Path to the authorization file. |               |
-|      `-debug`       | `--d` |           Debug mode            |     false     |
-|       `-api`        | `--a` |         Expose the API          |     false     |
-|   `-api-address`    |   /   |           API address           |  "localhost"  |
-|     `-api-port`     |   /   |            API port             |     4269      |
-
 ## 🐳 Deploying on Docker
 
 1. Build the client image on Docker:
@@ -49,20 +38,14 @@ registered.
 
 ## Deploying using docker-compose
 
-Alternatively, you can run the client, SteVe server and Watchtower on the same Pi using **docker-compose**.
-The **[Watchtower](https://github.com/containrrr/watchtower)** service will automatically pull the newest image and run
-it when it is available.
-
-1. Change the IP address under __serverUri__ in the settings file to **172.0.1.121**.
-
-2. Build services:
+2. Build the ChargePi client:
 
    ```bash
-   docker-compose build
+   docker-compose -f ./deployments build . 
    ```
 
 3. Run services in daemon mode:
 
    ```bash
-   docker-compose up -d
+   docker-compose -f ./deployments up -d
    ```

docs/contribution/adding-support-for-hardware.md

@@ -1,4 +1,4 @@
-# ➡️Adding support for hardware
+# ➡️Adding hardware support
 
 There are four hardware component groups that are included in the project: