1# Protobuf files for defining custom config-data packet structures
2
3This is an example proto file defining custom configuration related data packet structures, namely -
41. CustomConfigRequest - for sending configuration data consisting of various fields (Info and Version)
52. CustomConfigResponse - for receiving configuration status (fail/success)
6
7Note : These proto files are not automatically compiled during the build process.
8
9# Compilation
10
11Compilation requires protoc (Protobuf Compiler) and protoc-c (Protobuf C Compiler) installed. Since the generated files are to remain the same, as long as the proto files are not modified, therefore the generated files are already available under `examples/provisioning/custom_config/components/custom_provisioning/proto-c` and `examples/provisioning/custom_config/components/custom_provisioning/python` directories, and thus running cmake / make (and installing the Protobuf compilers) is optional.
12
13If using `cmake` follow the below steps. If using `make`, jump to Step 2 directly.
14
15## Step 1 (Only for cmake)
16
17When using cmake, first create a build directory and call cmake from inside:
18
19```
20mkdir build
21cd build
22cmake ..
23```
24
25## Step 2
26
27Simply run `make` to generate the respective C and Python files. The newly created files will overwrite those under `examples/provisioning/custom_config/components/custom_provisioning/proto-c` and `examples/provisioning/custom_config/components/custom_provisioning/python`
28