Documentation and pin mapping in Arduino - Mini Project: Build & Apply

Documentation and Pin Mapping

📖 Scenario: You are building a simple Arduino project that controls two LEDs and reads a button press. To keep your code clear and easy to understand, you will document the pin connections and create variables to map each pin.

🎯 Goal: Create variables to map the pins for two LEDs and one button. Add comments to document which pin controls which component. Then write code to set the pin modes and read the button state.

📋 What You'll Learn

Create variables named ledPin1, ledPin2, and buttonPin with exact pin numbers

Add comments explaining which pin is for which component

Use pinMode() to set the LEDs as outputs and the button as input

Read the button state into a variable named buttonState

Print the button state using Serial.println()

💡 Why This Matters

🌍 Real World

Documenting pin connections clearly helps when building or sharing Arduino projects, making it easier to understand and troubleshoot hardware wiring.

💼 Career

Clear pin mapping and documentation are essential skills for embedded systems developers and hardware engineers working with microcontrollers.

1

Set up pin mapping variables with documentation

Create three variables: ledPin1 set to 5, ledPin2 set to 6, and buttonPin set to 7. Add comments above each variable to document which component is connected to that pin.

Arduino

// Map pin 5 to first LED
// Map pin 6 to second LED
// Map pin 7 to button
int ledPin1 = 0;
int ledPin2 = 0;
int buttonPin = 0;
// Your code here

Hint

Use int to create variables and add comments with // before each variable.

2

Configure pin modes in setup()

Inside the setup() function, use pinMode() to set ledPin1 and ledPin2 as OUTPUT, and buttonPin as INPUT. Also start serial communication with Serial.begin(9600).

Arduino

// Map pin 5 to first LED
int ledPin1 = 5;
// Map pin 6 to second LED
int ledPin2 = 6;
// Map pin 7 to button
int buttonPin = 7;

void setup() {
  // Set ledPin1 as OUTPUT
  // Set ledPin2 as OUTPUT
  // Set buttonPin as INPUT
  // Start serial communication at 9600 baud
  // Your code here
}

void loop() {
}

Hint

Use pinMode(pin, mode) inside setup() to configure pins.

3

Read button state in loop()

Inside the loop() function, read the button state using digitalRead(buttonPin) and store it in an int variable named buttonState.

Arduino

// Map pin 5 to first LED
int ledPin1 = 5;
// Map pin 6 to second LED
int ledPin2 = 6;
// Map pin 7 to button
int buttonPin = 7;

void setup() {
  pinMode(ledPin1, OUTPUT);
  pinMode(ledPin2, OUTPUT);
  pinMode(buttonPin, INPUT);
  Serial.begin(9600);
}

void loop() {
  // Read the button state into buttonState
  // Your code here
}

Hint

Use digitalRead() to get the button state inside loop().

4

Print the button state

Add a line inside the loop() function to print the buttonState variable using Serial.println(buttonState).

Arduino

// Map pin 5 to first LED
int ledPin1 = 5;
// Map pin 6 to second LED
int ledPin2 = 6;
// Map pin 7 to button
int buttonPin = 7;

void setup() {
  pinMode(ledPin1, OUTPUT);
  pinMode(ledPin2, OUTPUT);
  pinMode(buttonPin, INPUT);
  Serial.begin(9600);
}

void loop() {
  int buttonState = digitalRead(buttonPin);
  // Print the buttonState
  // Your code here
}

Hint

Use Serial.println(buttonState); to print the button state.

Practice

1. What is the main purpose of pin mapping in Arduino projects?

easy

A. To reduce the power consumption of the board

B. To increase the speed of the Arduino board

C. To give pins clear and meaningful names in the code

D. To change the physical location of pins on the board

Solution

1. Step 1: Understand what pin mapping means

   Pin mapping means assigning clear names to pins in your code to make it easier to understand.

2. Step 2: Identify the main purpose

   The main purpose is to make the code readable and easier to maintain by using meaningful names.

3. Final Answer:

   To give pins clear and meaningful names in the code -> Option C

4. Quick Check:

   Pin mapping = Clear pin names [OK]

Hint: Pin mapping means naming pins clearly in code [OK]

Common Mistakes:

• Thinking pin mapping changes hardware
• Confusing pin mapping with power settings
• Assuming pin mapping speeds up the board

2. Which of the following is the correct way to define a pin mapping in Arduino code?

easy

A. int ledPin = 13;

B. pinMode(13) = ledPin;

C. digitalWrite(ledPin, 13);

D. define ledPin 13;

Solution

1. Step 1: Review Arduino syntax for pin mapping

   Pin mapping is done by assigning a pin number to a variable, usually with int.

2. Step 2: Check each option

   int ledPin = 13; correctly assigns pin 13 to variable ledPin. Others have wrong syntax or order.

3. Final Answer:

   int ledPin = 13; -> Option A

4. Quick Check:

   Pin mapping syntax = int variable = pin number [OK]

Hint: Use 'int variable = pinNumber;' to map pins [OK]

Common Mistakes:

• Using pinMode incorrectly for mapping
• Trying to assign pinMode as a variable
• Using 'define' without # for constants

3. What will be the output on the serial monitor after running this Arduino code?

int sensorPin = A0;
void setup() {
  Serial.begin(9600);
}
void loop() {
  int value = analogRead(sensorPin);
  Serial.println(value);
  delay(1000);
}

medium

A. The text 'sensorPin' printed every second

B. A number between 0 and 1023 printed every second

C. An error because A0 cannot be used in analogRead

D. Nothing prints because Serial.begin is missing

Solution

1. Step 1: Understand the code behavior

   The code reads analog input from pin A0 and prints the value to the serial monitor every second.

2. Step 2: Analyze the output

   analogRead returns a value from 0 to 1023 based on voltage. Serial.println prints this number.

3. Final Answer:

   A number between 0 and 1023 printed every second -> Option B

4. Quick Check:

   analogRead(A0) = 0-1023 values [OK]

Hint: analogRead returns 0-1023 values from analog pins [OK]

Common Mistakes:

• Thinking analogRead returns pin name
• Assuming A0 is invalid for analogRead
• Forgetting Serial.begin disables output

4. Identify the error in this Arduino code snippet related to pin mapping and fix it:

const int ledPin;
void setup() {
  ledPin = 13;
  pinMode(ledPin, OUTPUT);
}

medium

A. ledPin must be declared as a variable, not const

B. pinMode should be called before assigning ledPin

C. No error, code is correct

D. ledPin should be assigned when declared, not in setup()

Solution

1. Step 1: Understand const variable rules in Arduino

   Constants must be assigned a value when declared and cannot be assigned later.

2. Step 2: Identify the error in code

   Code declares const int ledPin; without value, then assigns in setup(), which is invalid.

3. Final Answer:

   ledPin should be assigned when declared, not in setup() -> Option D

4. Quick Check:

   const variables need immediate assignment [OK]

Hint: Assign const variables when declaring them [OK]

Common Mistakes:

• Assigning const variables later in code
• Thinking pinMode order matters here
• Ignoring const keyword rules

5. You want to document your Arduino project with multiple sensors and LEDs. Which approach best improves code readability and maintenance?

hard

A. Use descriptive pin mapping variables and add comments explaining each connection

B. Use raw pin numbers directly in code without comments

C. Write all code in one function without separating setup and loop

D. Avoid comments to keep code clean and short

Solution

1. Step 1: Understand importance of documentation and pin mapping

   Descriptive variable names and comments help others and yourself understand the project connections.

2. Step 2: Evaluate each option

   Use descriptive pin mapping variables and add comments explaining each connection uses clear names and comments, which is best practice. Others reduce clarity and maintainability.

3. Final Answer:

   Use descriptive pin mapping variables and add comments explaining each connection -> Option A

4. Quick Check:

   Good documentation = clear names + comments [OK]

Hint: Name pins clearly and comment connections [OK]

Common Mistakes:

• Using raw pin numbers without explanation
• Skipping comments thinking code is self-explanatory
• Mixing all code in one function