pWire Sensor

For Developers:

Requirements:

pWire Sensor 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)

Usage:

1. Change some code

2. Adjust tests if necessary or write new ones

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

    make build_test
    make run_test
   

4. Run cpplint (run in pwire-sensor 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)

Build prod

The CI builds the assets for prod but if you are testing with the board and want to build locally the following steps need to be taken (only for linux / in git directory).

1. Install arduino-cli (run in pwire-sensor directory):
   1. Set Environment-Variable BINDIR to a directory within your PATH e.g. export $BINDIR=/bin
   2. make prepare
2. make build_prod
3. make upload_prod PORT=<path of port>