Feature/proto api (#118)

Add a new API called proto api that allow to parse and generate request/response as per wirepas gateway api defined here: https://github.com/wirepas/backend-apis/tree/master/gateway_to_backend

---------

Co-authored-by: Stephane Triomphe <[email protected]>
Co-authored-by: GitHub Actions <>
Co-authored-by: vg-wp <[email protected]>

Author: 3 people

.github/workflows/c-cpp.yml

@@ -2,7 +2,6 @@ name: Build example
 
 on:
   push:
-    branches: [ master ]
   pull_request:
     branches: [ master ]
 
@@ -12,10 +11,21 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v2
+    - name: checkout code
+      uses: actions/checkout@v4
+      with:
+        submodules: true
     - name: make example
       run: make
       working-directory: example
+    - name: make proto example
+      run: make
+      working-directory: example/linux/proto-api
+    - name: install libpaho-mqtt
+      run: sudo apt install libpaho-mqtt-dev
+    - name: make gateway example
+      run: make
+      working-directory: example/linux/gw-example
     - name: make test
       run: make
       working-directory: test

.github/workflows/generate_protos.yml

@@ -0,0 +1,51 @@
+name: Generate proto file
+
+on:
+  push:
+    branches:
+      - master
+      - update_proto/**
+    paths:
+      - 'lib/wpc_proto/deps/nanopb/**'
+      - 'lib/wpc_proto/deps/backend-apis/**'
+      - 'lib/wpc_proto/proto_options/**'
+      - '.github/workflows/generate_protos.yml'
+      - 'lib/wpc_proto/tools/generate_proto_code.sh'
+
+  workflow_dispatch:
+    inputs:
+      message:
+        description: 'Commit message'
+        required: true
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: checkout code
+        uses: actions/checkout@v4
+        with:
+          submodules: true
+
+      - name: install python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.10'
+
+      - name: install requirements
+        run: pip install -r lib/wpc_proto/deps/nanopb/requirements.txt
+
+      - name: generate our proto files
+        run: lib/wpc_proto/tools/generate_proto_code.sh
+
+      - name: setup git config
+        run: |
+          git config user.name "GitHub Actions"
+          git config user.email "<>"
+
+      - name: commit
+        run: |
+          # Stage the file, commit and push
+          git add lib/wpc_proto/gen/generated_protos/*
+          git commit --allow-empty -m "Update generated proto files ${message}"
+          git push origin ${GITHUB_REF}

.gitmodules

@@ -0,0 +1,6 @@
+[submodule "lib/wpc_proto/deps/backend-apis"]
+	path = lib/wpc_proto/deps/backend-apis
+	url = https://github.com/wirepas/backend-apis
+[submodule "lib/wpc_proto/deps/nanopb"]
+	path = lib/wpc_proto/deps/nanopb
+	url = https://github.com/nanopb/nanopb.git

example/linux/gw-example/Readme.md

@@ -0,0 +1,38 @@
+# Gateway example
+
+## Overview
+
+This application example implements the Wirepas Gateway API (MQTT + protobuf messages) in a single monolithic application.
+
+This example is based on Linux environment but can be used as a starting point for a different platform.
+Linux is chosen here as it is the default target for c-mesh-api library and it is easy to execute from a PC.
+
+This example mainly demonstrates the usage of the proto API of c-mesh-api and the "glue" required to convert it into a Wirepas gateway with an MQTT client.
+
+## Installation
+
+In order to build this application in Ubuntu (only tested environment) you need the libpaho-mqtt library:
+
+```bash
+sudo apt install libpaho-mqtt-dev
+```
+
+Application can be built directly with following command:
+
+```bash
+make
+```
+
+## Usage
+
+Some parameters are mandatory to start the application:
+
+```bash
+Usage: gw-example -p <port name> [-b <baudrate>] -g <gateway_id> -H <mqtt hostname> [-U <mqtt user>] [-P <mqtt password>]
+```
+
+## Limitation
+
+This example implements only the "happy case". There is no buffering implemented in case the connection to the broker is down.
+Mqtt client is used in synchronous mode so may have an impact on the global performances.
+