xEventGroupCreate() function in FreeRTOS - Mini Project: Build & Apply

Using the xEventGroupCreate() Function in FreeRTOS

📖 Scenario: You are working on a FreeRTOS project where multiple tasks need to synchronize their actions using event groups. Event groups allow tasks to wait for one or more events to occur before continuing.

🎯 Goal: Learn how to create an event group using the xEventGroupCreate() function and check if it was created successfully.

📋 What You'll Learn

Create an event group handle variable called eventGroup.

Use the xEventGroupCreate() function to create the event group.

Check if the event group was created successfully by verifying eventGroup is not NULL.

Print "Event group created successfully." if creation succeeded.

Print "Failed to create event group." if creation failed.

💡 Why This Matters

🌍 Real World

Event groups are used in embedded systems to synchronize multiple tasks efficiently, such as waiting for sensor data or communication events.

💼 Career

Understanding event groups is important for embedded software developers working with FreeRTOS to build reliable multitasking applications.

1

Create an event group handle variable

Declare a variable called eventGroup of type EventGroupHandle_t to hold the event group handle.

FreeRTOS

EventGroupHandle_t eventGroup;
// Your code here

Hint

Use the type EventGroupHandle_t to declare the event group handle variable.

2

Create the event group using xEventGroupCreate()

Assign the result of xEventGroupCreate() to the variable eventGroup.

FreeRTOS

EventGroupHandle_t eventGroup;

// Create the event group
// Your code here

Hint

Call xEventGroupCreate() and assign its return value to eventGroup.

3

Check if the event group was created successfully

Write an if statement to check if eventGroup is not NULL.

FreeRTOS

EventGroupHandle_t eventGroup;

eventGroup = xEventGroupCreate();

// Check if eventGroup is not NULL
// Your code here

Hint

Use if (eventGroup != NULL) to check if creation succeeded.

4

Print the result of event group creation

Inside the if block, write printf("Event group created successfully.\n");. In the else block, write printf("Failed to create event group.\n");.

FreeRTOS

EventGroupHandle_t eventGroup;

eventGroup = xEventGroupCreate();

if (eventGroup != NULL) {
    // Print success message
    // Your code here
} else {
    // Print failure message
    // Your code here
}

Hint

Use printf to display messages inside the if and else blocks.

Practice

1. What does the xEventGroupCreate() function do in FreeRTOS?

easy

A. Creates a new event group and returns its handle

B. Deletes an existing event group

C. Sends an event to a task

D. Creates a new task

Solution

1. Step 1: Understand the purpose of xEventGroupCreate()

   This function is designed to create a new event group in FreeRTOS, which is used for task communication.

2. Step 2: Identify the return value

   The function returns a handle to the newly created event group, which is used to interact with it later.

3. Final Answer:

   Creates a new event group and returns its handle -> Option A

4. Quick Check:

   xEventGroupCreate() creates event group = A [OK]

Hint: Remember: create means new event group and get handle [OK]

Common Mistakes:

• Confusing creation with deletion
• Thinking it sends events instead of creating groups
• Assuming it creates tasks

2. Which of the following is the correct way to declare and create an event group using xEventGroupCreate()?

easy

A. xEventGroupHandle_t xEventGroup = xEventGroupCreate();

B. EventGroupHandle_t xEventGroup = CreateEventGroup();

C. EventGroupHandle_t xEventGroup = xCreateEventGroup();

D. EventGroupHandle_t xEventGroup = xEventGroupCreate();

Solution

1. Step 1: Check the correct type name

   The correct type for event group handles is EventGroupHandle_t.

2. Step 2: Verify the function name

   The function to create an event group is exactly xEventGroupCreate().

3. Final Answer:

   EventGroupHandle_t xEventGroup = xEventGroupCreate(); -> Option D

4. Quick Check:

   Correct type and function name = C [OK]

Hint: Match exact type and function name spelling [OK]

Common Mistakes:

• Using wrong type name like xEventGroupHandle_t
• Using incorrect function names
• Missing the semicolon

3. What will be the output of the following code snippet?

EventGroupHandle_t xGroup;
xGroup = xEventGroupCreate();
if (xGroup == NULL) {
    printf("Failed to create event group\n");
} else {
    printf("Event group created successfully\n");
}

medium

A. Event group created successfully

B. No output

C. Compilation error

D. Failed to create event group

Solution

1. Step 1: Understand xEventGroupCreate() return value

   This function returns a valid handle if creation succeeds, otherwise NULL.

2. Step 2: Analyze the if condition

   The code checks if the handle is NULL. If not NULL, it prints success message.

3. Final Answer:

   Event group created successfully -> Option A

4. Quick Check:

   Handle != NULL means success = D [OK]

Hint: Check if handle is NULL to confirm creation success [OK]

Common Mistakes:

• Assuming NULL means success
• Confusing printf output strings
• Ignoring the if condition logic

4. Identify the error in the following code snippet that uses xEventGroupCreate():

EventGroupHandle_t xGroup;
xGroup = xEventGroupCreate;
if (xGroup == NULL) {
    // handle error
}

medium

A. Incorrect variable type for xGroup

B. Missing parentheses when calling xEventGroupCreate

C. No check for NULL handle

D. Using wrong function name

Solution

1. Step 1: Check function call syntax

   The code assigns xEventGroupCreate without parentheses, so it assigns the function pointer, not the result.

2. Step 2: Understand correct usage

   To call the function and get the handle, parentheses are required: xEventGroupCreate().

3. Final Answer:

   Missing parentheses when calling xEventGroupCreate -> Option B

4. Quick Check:

   Function call needs () = B [OK]

Hint: Always use () to call functions, not just name [OK]

Common Mistakes:

• Forgetting parentheses on function calls
• Confusing function pointer with return value
• Not checking for NULL after creation

5. You want to create an event group and ensure your program handles failure gracefully. Which code snippet correctly creates the event group and checks for failure?

hard

A. EventGroupHandle_t xGroup = xEventGroupCreate(); if (xGroup == NULL) { /* proceed */ } else { /* handle error */ }

B. EventGroupHandle_t xGroup; xGroup = xEventGroupCreate; if (xGroup == NULL) { /* handle error */ }

C. EventGroupHandle_t xGroup = xEventGroupCreate(); if (xGroup != NULL) { /* proceed */ } else { /* handle error */ }

D. EventGroupHandle_t xGroup = CreateEventGroup(); if (xGroup == NULL) { /* handle error */ }

Solution

1. Step 1: Verify correct function call and assignment

   EventGroupHandle_t xGroup = xEventGroupCreate(); if (xGroup != NULL) { /* proceed */ } else { /* handle error */ } correctly calls xEventGroupCreate() with parentheses and assigns the handle.

2. Step 2: Check the logic for failure handling

   It checks if the handle is not NULL to proceed, else handles error. This is the correct logic.

3. Final Answer:

   EventGroupHandle_t xGroup = xEventGroupCreate(); if (xGroup != NULL) { /* proceed */ } else { /* handle error */ } -> Option C

4. Quick Check:

   Correct call and NULL check = A [OK]

Hint: Call with () and check if handle is NULL to handle errors [OK]

Common Mistakes:

• Not using parentheses on function call
• Reversing NULL check logic
• Using wrong function name