xEventGroupCreate() function in FreeRTOS - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is the purpose of the xEventGroupCreate() function in FreeRTOS?

It creates a new event group, which is a collection of bits used for task synchronization and communication.

beginner

What type of value does xEventGroupCreate() return?

It returns a handle to the created event group, which is used to reference the event group in other API calls.

intermediate

Can xEventGroupCreate() fail? If yes, what happens?

Yes, it can fail if there is not enough heap memory. In that case, it returns NULL instead of a valid handle.

intermediate

How do tasks use the event group created by xEventGroupCreate()?

Tasks can set, clear, and wait for bits in the event group to synchronize actions or communicate events.

intermediate

Is it necessary to delete an event group created by xEventGroupCreate()? How?

Yes, to free memory, use vEventGroupDelete() with the event group handle when it is no longer needed.

What does xEventGroupCreate() return if it fails to create an event group?

A 0

B An error code

C -1

D NULL

If xEventGroupCreate() fails, it returns NULL to indicate no event group was created.

Which FreeRTOS feature does xEventGroupCreate() help implement?

A Interrupt handling

B Task synchronization using event bits

C Memory allocation

D Timer creation

xEventGroupCreate() creates event groups used for task synchronization with event bits.

What must you do after finishing with an event group created by xEventGroupCreate()?

A Call <code>vEventGroupDelete()</code> to free resources

B Nothing, it frees automatically

C Call <code>vTaskDelete()</code>

D Reset the event bits

To avoid memory leaks, you should delete the event group using vEventGroupDelete().

Which of these is NOT a use of event groups created by xEventGroupCreate()?

A Allocating heap memory

B Setting flags to signal events

C Clearing event bits

D Waiting for multiple events simultaneously

Event groups do not allocate heap memory; they are used for signaling and synchronization.

What data type is the handle returned by xEventGroupCreate()?

A void*

B int

C EventGroupHandle_t

D TaskHandle_t

The function returns an EventGroupHandle_t, a pointer type used to manage event groups.

Explain how xEventGroupCreate() fits into task synchronization in FreeRTOS.

Think about how tasks can wait for signals using bits.

Describe the steps to safely use and then delete an event group created with xEventGroupCreate().

Consider resource management in embedded systems.

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