chore: improve docs

.github/dependabot.yaml

@@ -3,26 +3,14 @@ updates:
   - package-ecosystem: "github-actions"
     directory: "/"
     schedule:
-      interval: "weekly"
-    assignees:
-      - "xBlaz3kx"
-    reviewers:
-      - "xBlaz3kx"
+      interval: "monthly"
 
   - package-ecosystem: "docker"
     directory: "/"
     schedule:
-      interval: "weekly"
-    assignees:
-      - "xBlaz3kx"
-    reviewers:
-      - "xBlaz3kx"
+      interval: "monthly"
 
   - package-ecosystem: "npm"
     directory: "/"
     schedule:
-      interval: "weekly"
-    assignees:
-      - "xBlaz3kx"
-    reviewers:
-      - "xBlaz3kx"
+      interval: "monthly"

.github/workflows/deployment.yaml

@@ -4,8 +4,9 @@ on:
   push:
     branches:
       - master
-    # Review gh actions docs if you want to further define triggers, paths, etc
-    # https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on
+  pull_request:
+    branches:
+      - master
 
 jobs:
   build:
@@ -30,7 +31,7 @@ jobs:
           version: 10.11.0
 
       - name: Install dependencies
-        run: pnpm install # --frozen-lockfile
+        run: pnpm install --frozen-lockfile
       - name: Build website
         run: pnpm build
 
@@ -42,6 +43,7 @@ jobs:
   deploy:
     name: Deploy to GitHub Pages
     needs: build
+    if: ${{ github.event_name != 'pull_request' }}
 
     # Grant GITHUB_TOKEN the permissions required to make a Pages deployment
     permissions:

blog/2021-08-12-welcome.md

@@ -1,9 +1,7 @@
 ---
 slug: welcome
 title: Welcome 
-author: xBlaz3kx
-author_title: Developer 
-author_url: https://github.com/xBlaz3kx
+author: bdular
 tags: [charge-pi, hello]
 ---
 

blog/authors.yml

@@ -0,0 +1,8 @@
+bdular:
+  name: Blaž Dular
+  title: Software Engineer
+  url: https://github.com/xBlaz3kx
+  image_url: https://github.com/xBlaz3kx.png
+  email: [email protected]
+  socials:
+    github: xBlaz3kx

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

@@ -0,0 +1,57 @@
+---
+sidebar_position: 4
+---
+
+# ➡️Adding hardware support
+
+There are four hardware component groups that are included in the project:
+
+1. NFC/RFID tag reader,
+2. LCD (display),
+3. (Led) Indicator,
+4. Power meter,
+5. EVCC.
+
+These hardware components have corresponding interfaces that are included in the `ChargePointHandler` struct. This
+allows adding support for other models of hardware with similar functionalities.
+
+You're welcome to submit a Pull Request with any additional hardware model implementations! Be sure to test and document
+your changes, update the [supported hardware](../hardware/hardware.md) table(s) with the new hardware model(s). It would
+be nice to have a wiring sketch or a connection table included for the new model(s).
+
+## 💳 Reader hardware
+
+All readers must implement the `Reader` interface. It is recommended that you implement the interface in a new file
+named after the model of the reader in the `hardware/reader` package. Then you should add a **constant** named after
+the **model** of the reader in the `reader` file in the package and add a switch case with the implementation and the
+necessary logic that returns a pointer to the struct.
+
+The settings of the reader are read from the `settings.json` file, which is stored in the cache and are available in the
+NewTagReader method.
+
+## 🖥️ Display hardware
+
+All displays must implement the `LCD` interface. It is recommended that you implement the interface in a new file named
+after the model of the display/LCD in the `hardware/display` package. Then you should add a **constant** named after
+the **model** of the display in the `display` file in the package and add a switch case with the implementation and the
+necessary logic that returns a pointer to the struct.
+
+## Indicator hardware
+
+The process is the same as the previous description.
+
+## ⚡ EVCC
+
+The process is similar to other components. Note: Init method will be called whenever the charge point boots.
+The init method should perform any necessary setup steps, such as opening a communication path. Any two-way
+communication should be initiated in another thread and should communicate through channels.
+
+## ⚡ Power meters
+
+The process is the same as the previous description.
+
+## ⚡ EVCC
+
+The process is similar to other components. Note: Init method will be called whenever the charge point boots.
+The init method should perform any necessary setup steps, such as opening a communication path. Any two-way
+communication should be initiated in another thread and should communicate through channels.

docs/go-client/configuration.md → docs/client/configuration.md

@@ -72,11 +72,11 @@ or might not work properly.
 
 #### chargePoint info
 
-|    Attribute    |                            Description                             |   Possible values   | 
-|:---------------:|:------------------------------------------------------------------:|:-------------------:|
-| maxChargingTime | Maxiumum amount of time that a transaction can last (in minutes).  |    Default: 180     |
-|   ocpp.vendor   |                             Vendor ID                              | Default: "xBlaz3k"  |
-|   ocpp.model    |                               Model                                | Default: "ChargePi" |
+|    Attribute    |                           Description                            |   Possible values   | 
+|:---------------:|:----------------------------------------------------------------:|:-------------------:|
+| maxChargingTime | Maximum amount of time that a transaction can last (in minutes). |    Default: 180     |
+|   ocpp.vendor   |                            Vendor ID                             | Default: "xBlaz3k"  |
+|   ocpp.model    |                              Model                               | Default: "ChargePi" |
 
 #### chargePoint hardware
 
@@ -175,14 +175,14 @@ EVSE with the provided configuration.
 
 #### Attributes
 
-| Attribute  |                Description                |             Possible values             | 
-|:----------:|:-----------------------------------------:|:---------------------------------------:|
-|   evseId   |              ID of the EVSE               |                   >1                    |
-| connectors | List of available connectors for the EVSE ||
-|    evcc    |            Charging Controller            ||
-|   status   |            Status of the EVSE             | "Available", "Charging", "Faulted",...  |
-|  session   |          Persistent session data          ||
-| powerMeter |    Power Meter configuration for EVSE     || 
+| Attribute  |                Description                |            Possible values             | 
+|:----------:|:-----------------------------------------:|:--------------------------------------:|
+|   evseId   |              ID of the EVSE               |                   >1                   |
+| connectors | List of available connectors for the EVSE |                                        |
+|    evcc    |            Charging Controller            |                                        |
+|   status   |            Status of the EVSE             | "Available", "Charging", "Faulted",... |
+|  session   |          Persistent session data          |                                        |
+| powerMeter |    Power Meter configuration for EVSE     |                                        | 
 
 #### evcc
 
@@ -207,11 +207,11 @@ EVSE with the provided configuration.
 
 #### connectors
 
-|   Attribute   |       Description       |            Possible values            | 
-|:-------------:|:-----------------------:|:-------------------------------------:|
-|  connectorId  |      connector ID       |          Default:"ChargePi"           |
-|     type      |  type of the connector  | "Schuko", "Type1","Type2", "CCS", ... |
-|    status     | Status of the connector |     "Available", "Charging", ...      |
+|  Attribute  |       Description       |            Possible values            | 
+|:-----------:|:-----------------------:|:-------------------------------------:|
+| connectorId |      connector ID       |          Default:"ChargePi"           |
+|    type     |  type of the connector  | "Schuko", "Type1","Type2", "CCS", ... |
+|   status    | Status of the connector |     "Available", "Charging", ...      |
 
 Example EVSE configuration:
 
@@ -248,4 +248,4 @@ Example EVSE configuration:
     "voltageDividerOffset": 1333
   }
 }
-``````
+```

docs/go-client/installing-libraries.md → docs/client/installing-libraries.md

@@ -12,11 +12,11 @@ you use this if you do not want to (re)configure anything.
 
 Usage:
 
-```bash
- cd ~/ChargePi-go/docs
- chmod +x install-dependencies.sh
- ./install-dependencies.sh 1
-```
+   ```bash
+    cd ~/ChargePi-go/docs
+    chmod +x install-dependencies.sh
+    ./install-dependencies.sh 1
+   ```
 
 ## Building libnfc for PN532