pWire Server

For Users:

Latest build --> ToDo

Configuration

The Server has to be configured by the pwire-server.cfg file which has to be located in the same directory as the executable. The file looks like this:

[general]
uuid = {{uuid}}
[redis]
host = 127.0.0.1
port = 6379
password = {{redis_password}}
[lora]
serial_device = /dev/ttyS1
aux_pin = 1
m0_pin = 3
m1_pin = 2

Should redis not require a password leave the password option value empty: password = . You can theoretically write anything as value since it is ignored if not needed.

For Developers:

Requirements:

pWire Server needs at least C++17

pWire Server uses the following software for it's build process:

• cpplint for linting
• cute as testing framework
• make as build-management tool

1. Install make on your pc
2. Install cpplint on your pc (pip can be used see link above)
3. Use a IDE to your liking (cevelop supports both makefiles and cute)

pwire Server is dependent on the following libraries:

• Boost.Asio
• cpp_redis

1. Install cpp_redis -> instructions
2. Boost asio and system libraries have to be installed for the serial port
   1. For linux -> sudo apt install libasio-dev libboost-system-dev
   2. For Windows -> Instructions

Usage:

1. Change some code

2. Adjust tests if necessary or write new ones

3. Run tests (run in pwire-server directory)

    make build_test
    make run_test
   

4. Run cpplint (run in pwire-server directory)

    make lint
   

   For vscode exists an extension for cpplint which can also be used with the config:

    {
        "editor.suggestSelection": "first",
        "vsintellicode.modify.editor.suggestSelection": "automaticallyOverrodeDefaultValue",
        "java.errors.incompleteClasspath.severity": "ignore",
        "cpplint.filters": [
            "-legal/copyright"
        ],
        "cpplint.excludes": ["test/cute", ".metadata"]
    }

5. Upload to repo (only if 3. and 4. had no errors)

6. To create an executable manually without CI run make build_prod