Speeduino

https://wiki.speeduino.com

Admin

Speeduino is an open-source engine management system (ECU) that provides hardware boards, firmware,...

Tokens:5,872

Snippets:107

Trust Score:8.9

Update:6 months ago

Show doc for...

Tokens:

Raw

### MISRA Scanning Script Usage

Source: https://wiki.speeduino.com/dev/Style_code

This script helps identify MISRA C:2012 violations in the Speeduino code. Ensure cppcheck and Python 3.x are installed and run this script from the 'speeduino/misra' directory.

```bash
./check_misra.sh -s=../speeduino/ -e=c -o=./results -c=/usr/bin/cppcheck -q
```

--------------------------------

### Conditional Comparison in Executable Statements

Source: https://wiki.speeduino.com/dev/Style_code

Always use explicit comparisons (e.g., `== 1`, `== 0`, `== true`, `== false`) in if statements, rather than relying on the truthiness of a variable. This enhances code clarity and adheres to MISRA guidelines.

```c
if(isEnabled == 1)
```

--------------------------------

### C Code Block Formatting

Source: https://wiki.speeduino.com/dev/Style_code

For multi-line code blocks, always place opening and closing braces on their own lines. This improves readability and structure.

```c
void readSensors()
{
  analogRead(sensor1);
  analogRead(sensor2);
}
```

--------------------------------

### Single-Line If Statement Formatting

Source: https://wiki.speeduino.com/dev/Style_code

When using if statements on a single line, they must include braces and a trailing space after the condition. This ensures clarity and prevents potential errors.

```c
if(fanEnabled) { digitalWrite(fanPin, HIGH); }
```

Tokens:

Raw