In this exercise, we will simply redo Exercise 1 of this lesson but this time we will be using the feature-rich logger module. We will enable the logger, and utilize it to print logs of different severities and to hexdump variables.
Log level output and description
The timestamping feature (LOG_BACKEND_FORMAT_TIMESTAMP) and the coloring of error and warning logs feature (LOG_BACKEND_SHOW_COLOR) are enabled by default. Again, the logger gets the timestamp by calling the kernel function k_cycle_get_32() internally. This routine returns the current time since bootup (uptime), as measured by the system’s hardware clock. You could change this to return an actual time and date if an external Real-time clock is present on the system. We will use the previous exercise code as a starting point.
Before starting, ensure that your development kit is powered on and connected and that your terminal emulator is configured properly as we did in steps 2 to 4 in Exercise 1.
1. Download the base exercise project and extract it in your exercise folder for this course.
2. Enable the logger module. This is done by adding the configuration line below to the application configuration file prj.conf
CONFIG_LOG=y
Make sure to save the prj.conf file (Ctrl+S). Adding the CONFIG_LOG=y will include the logger module source code into the build.
Note
In Visual Studio Code you can enable auto-saving with File -> Auto Save. This will save you time by not having to save manually.
3. Open main.c inside the fund_less4_exer2\src directory.
4. Include the header file of the logger module.
Search for STEP 4 in main.c, and write the following line:
#include <logging/log.h>
5. Register your code with the logger module.
In order to use the logger, you must register with it first. This is done by using the macro LOG_MODULE_REGISTER() which takes two parameters:
A mandatory module name. The module name will be included in every log entry which helps in distinguishing messages generated by different modules and/or filtering. The module name must NOT be passed as a string. In other words, don’t use quotation marks “”.
An optional maximal log level for the module. The maximal log level will determine which messages will be send to the console. For instance if you set the log level of module X to LOG_LEVEL_DBG, it means all messages generated(Debug, Info, Warning, and Error) will be send to the console. On the other hand, if you set the maximal log level of module Y to LOG_LEVEL_WRN, it means only messages with severity level of warning and error will be sent to the console. If the minimum log level is not provided, then default global log level (CONFIG_LOG_DEFAULT_LEVEL) is used in the file. The default global log level is set to LOG_LEVEL_INF.
For this exercise, we will name the module Less4_Exer2 and we will use the lowest logging level which is LOG_LEVEL_DBG (Send all messages generated by module Less4_Exer2 to console).
Search for STEP 5 in main.c, and write the following code:
LOG_MODULE_REGISTER(Less4_Exer2,LOG_LEVEL_DBG);
6. We are all set! Let’s write some logs. We will experiment with printing some messages (logs) will all levels (debug, info, warning, and error) and also hex dumping some variable.
Copy the code below:
int exercise_num=2;
uint8_t data[] = {0x00, 0x01, 0x02, 0x03,
0x04, 0x05, 0x06, 0x07,
'H', 'e', 'l', 'l','o'};
//Printf-like messages
LOG_INF("nRF Connect SDK Fundamentals");
LOG_INF("Exercise %d",exercise_num);
LOG_DBG("A log message in debug level");
LOG_WRN("A log message in warning level!");
LOG_ERR("A log message in Error level!");
//Hexdump some data
LOG_HEXDUMP_INF(data, sizeof(data),"Sample Data!");
We will replace the old printk() from the previous exercise with the more capable logger macro calls as shown in the illustration below:
7. Change the callback function button_pressed() to use the asynchronous logger API instead of the blocking prinkt().
Copy the new button_pressed()function. The key difference between the old callback function and the new one is that the new one uses the logger macros instead of printk()blocking calls.
void button_pressed(const struct device *dev, struct gpio_callback *cb,
uint32_t pins)
{
int i;
int j;
long int factorial;
LOG_INF("Calculating the factorials of numbers 1 to %d:",MAX_NUMBER_FACT);
for (i=1;i<=MAX_NUMBER_FACT;i++){
factorial =1;
for (j=1;j<=i;j++){
factorial = factorial*j;
}
LOG_INF("The factorial of %2d = %ld",i,factorial);
}
/*Important note!
Code in ISR runs at a high priority, therefore, it should be written with timing in mind.
Too lengthy or too complex tasks should not be performed by an ISR, they should be deferred to a thread
*/
}
Replace the button_pressed()function with the copied code as shown below:
8. Build the exercise as we have done in the previous lessons.
9. Flash it to the board as we have done in the previous lessons.
Using a serial terminal, you should see the following output:
*** Booting Zephyr OS build v2.7.0-ncs1 ***
[00:00:00.256,256] <inf> Less4_Exer2: nRF Connect SDK Fundamentals
[00:00:00.256,256] <inf> Less4_Exer2: Exercise 2
[00:00:00.256,256] <dbg> Less4_Exer2.main: A log message in debug level
[00:00:00.256,256] <wrn> Less4_Exer2: A log message in warning level!
[00:00:00.256,256] <err> Less4_Exer2: A log message in Error level!
[00:00:00.256,256] <inf> Less4_Exer2: Sample Data!
00 01 02 03 04 05 06 07 48 65 6c 6c 6f |........ Hello
Any time you press Button 1 you should observe that the factorials of the numbers from 1 to 10 are printed on the console as shown below:
[00:00:06.900,482] <inf> Less4_Exer2: Calculating the factorials of numbers 1 to 10:
[00:00:06.900,512] <inf> Less4_Exer2: The factorial of 1 = 1
[00:00:06.900,512] <inf> Less4_Exer2: The factorial of 2 = 2
[00:00:06.900,512] <inf> Less4_Exer2: The factorial of 3 = 6
[00:00:06.900,543] <inf> Less4_Exer2: The factorial of 4 = 24
[00:00:06.900,543] <inf> Less4_Exer2: The factorial of 5 = 120
[00:00:06.900,543] <inf> Less4_Exer2: The factorial of 6 = 720
[00:00:06.900,543] <inf> Less4_Exer2: The factorial of 7 = 5040
[00:00:06.900,543] <inf> Less4_Exer2: The factorial of 8 = 40320
[00:00:06.900,573] <inf> Less4_Exer2: The factorial of 9 = 362880
[00:00:06.900,573] <inf> Less4_Exer2: The factorial of 10 = 3628800
You can download the solution for Exercise 2 below.
In this Privacy Policy you will find information on Nordic Semiconductor ASA (“Nordic Semiconductor”) processes your personal data when you use the Nordic Developer Academy.
References to “we” and “us” in this document refers to Nordic Semiconductor.
2. Our processing of personal data when you use the Nordic Developer Academy
2.1 Nordic Developer Academy
Nordic Semiconductor processes personal data in order to provide you with the features and functionality of the Nordic Developer Academy. Creating a user account is optional, but required if you want to track you progress and view your completed courses. If you choose to create a user account, we will process the following categories of personal data:
Email
Name
Password (encrypted)
Course progression (e.g. which course you have completely or partly completed)
Course results
During your use of the Nordic Developer Academy, you may also be asked if you want to provide feedback. If you choose to respond to any such surveys, we will also process your responses in that survey.
The legal basis for this processing is GDPR article 6 (1) b. The processing is necessary for Nordic Semiconductor to provide the Nordic Developer Academy under the Terms of Service.
2.2 Analytics
If you consent to analytics, Nordic Semiconductor will use Google Analytics to obtain statistics about how the Nordic Developer Academy is used. This includes collecting information on for example what pages are viewed, the duration of the visit, the way in which the pages are maneuvered, what links are clicked, technical information about your equipment. The information is used to learn how Nordic Developer Academy is used and how the user experience can be further developed.
2.2 Newsletter
You can consent to receive newsletters from Nordic from within the Nordic Developer Academy. How your personal data is processed when you sign up for our newsletters is described in the Nordic Semiconductor Privacy Policy.
3. Retention period
We will store your personal data for as long you use the Nordic Developer Academy. If our systems register that you have not used your account for 36 months, your account will be deleted.
4. Additional information
Additional information on how we process personal data can be found in the Nordic Semiconductor Privacy Policy and Cookie Policy.
Nordic Developer Academy Terms of Service
1. Introduction
These terms and conditions (“Terms of Use”) apply to the use of the Nordic Developer Academy, provided by Nordic Semiconductor ASA, org. nr. 966 011 726, a public limited liability company registered in Norway (“Nordic Semiconductor”).
Nordic Developer Academy allows the user to take technical courses related to Nordic Semiconductor products, software and services. By completing the registration process for the Nordic Developer Academy, you are agreeing to be bound by these Terms of Use.
These Terms of Use are applicable as long as you have a user account giving you access to Nordic Developer Academy.
2. Access to and use of Nordic Developer Academy
Upon acceptance of these Terms of Use you are granted a non-exclusive right of access to, and use of Nordic Developer Academy, as it is provided to you at any time. Nordic Semiconductor provides Nordic Developer Academy to you free of charge, subject to the provisions of these Terms of Use and the Nordic Developer Academy Privacy Policy.
To access select features of Nordic Developer Academy, you need to create a user account. You are solely responsible for the security associated with your user account, including always keeping your login detail safe.
Nordic Semiconductor will continuously develop Nordic Developer Academy with new features and functionality, but reserves the right to remove or alter any existing functions without notice.
3. Acceptable use
You undertake that you will use Nordic Developer Academy in accordance with applicable law and regulations, and in accordance with these Terms of Use. You must not modify, adapt, or hack Nordic Developer Academy or modify another website so as to falsely imply that it is associated with Nordic Developer Academy, Nordic Semiconductor, or any other Nordic Semiconductor product, software or service.
You agree not to reproduce, duplicate, copy, sell, resell or in any other way exploit any portion of Nordic Developer Academy, use of Nordic Developer Academy, or access to Nordic Developer Academy without the express written permission by Nordic Semiconductor. You must not upload, post, host, or transmit unsolicited email, SMS, or “spam” messages.
You are responsible for ensuring that the information you post and the content you share does not;
contain false, misleading or otherwise erroneous information
infringe someone else’s copyrights or other intellectual property rights
contain sensitive personal data or
contain information that might be received as offensive or insulting.
Such information may be removed without prior notice.
Nordic Semiconductor reserves the right to at any time determine whether a use of Nordic Developer Academy is in violation of its requirements for acceptable use.
Violation of the at any time applicable requirements for acceptable use may result in termination of your account. We will take reasonable steps to notify you and state the reason for termination in such cases.
4. Routines for planned maintenance
Certain types of maintenance may imply a stop or reduction in availability of Nordic Developer Academy. Nordic Semiconductor does not warrant any level of service availability but will provide its best effort to limit the impact of any planned maintenance on the availability of Nordic Developer Academy.
5. Intellectual property rights
Nordic Semiconductor retains all rights to all elements of Nordic Developer Academy. This includes, but is not limited to, the concept, design, trademarks, know-how, trade secrets, copyrights and all other intellectual property rights.
Nordic Semiconductor receives all rights to all content uploaded or created in Nordic Developer Academy. You do not receive any license or usage rights to Nordic Developer Academy beyond what is explicitly stated in this Agreement.
6. Liability and damages
Nothing within these Terms of Use is intended to limit your statutory data privacy rights as a data subject, as described in the Nordic Developer Academy Privacy Policy. You acknowledge that errors might occur from time to time and waive any right to claim for compensation as a result of errors in Nordic Developer Academy. When an error occurs, you shall notify Nordic Semiconductor of the error and provide a description of the error situation.
You agree to indemnify Nordic Semiconductor for any loss, including indirect loss, arising out of or in connection with your use of Nordic Developer Academy or violations of these Terms of Use. Nordic Semiconductor shall not be held liable for, and does not warrant that (i) Nordic Developer Academy will meet your specific requirements, (ii) Nordic Developer Academy will be uninterrupted, timely, secure, or error-free, (iii) the results that may be obtained from the use of Nordic Developer Academy will be accurate or reliable, (iv) the quality of any products, services, information, or other material purchased or obtained by you through Nordic Developer Academy will meet your expectations, or that (v) any errors in Nordic Developer Academy will be corrected.
You accept that this is a service provided to you without any payment and hence you accept that Nordic Semiconductor will not be held responsible, or liable, for any breaches of these Terms of Use or any loss connected to your use of Nordic Developer Academy. Unless otherwise follows from mandatory law, Nordic Semiconductor will not accept any such responsibility or liability.
7. Change of terms
Nordic Semiconductor may update and change the Terms of Use from time to time. Nordic Semiconductor will seek to notify you about significant changes before such changes come into force and give you a possibility to evaluate the effects of proposed changes. Continued use of Nordic Developer Academy after any such changes shall constitute your acceptance of such changes. You can review the current version of the Terms of Use at any time at: [URL].
8. Transfer of rights
Nordic Semiconductor is entitled to transfer its rights and obligation pursuant to these Terms of Use to a third party as part of a merger or acquisition process, or as a result of other organizational changes.
9. Third Party Services
To the extent Nordic Developer Academy facilitates access to services provided by a third party, you agree to comply with the terms governing such third party services. Nordic Semiconductor shall not be held liable for any errors, omissions, inaccuracies, etc. related to such third party services.
10. Dispute resolution
The Terms of Use and any other legally binding agreement between yourself and Nordic Semiconductor shall be subject to Norwegian law and Norwegian courts’ exclusive jurisdiction.
Login
Accessing this course requires a login. Please enter your credentials below!