Feedback

HTTP library

HTTP client library

The HTTP client library allows you to configure your device as a HTTP client, and enables you to send HTTP requests to an HTTP server and parse the responses received by the server.

Although the library communicates over the socket API, the application is responsible for creating a socket and passing it to the library.

Create an HTTP request

Create an HTTP request of type struct http_request, which will contain all the data necessary for doing an HTTP request.

In the code snippet below, we are creating an HTTP request and populating the essential members to be able to send a PUT request.

struct http_request req;
static uint8_t recv_buf[512];

const char *headers[] = {"Connection: close\r\n", NULL};
char * payload_buf = "payload";

req.header_fields = headers;
req.method = HTTP_PUT;
req.url = "/";
req.host = HTTP_HOSTNAME;
req.protocol = "HTTP/1.1";
req.payload = payload_buf;
req.payload_len = strlen(payload_buf);
req.response = response_cb;
req.recv_buf = recv_buf;
req.recv_buf_len = sizeof(recv_buf);

header_fields: the HTTP header fields. For example: Connection, Content-Type, Authorization
method: HTTP method of the request. For example: GET, POST, PUT, etc. Defined by the enum http_method
url: URL for the request. For example “/new”
host: Hostname to be used in the request
protocol: HTTP version being used, necessary for the header. For example “HTTP/1.1”
payload: Payload of HTTP request
payload_len: Payload length, used to calculate HTTP Content-Length header
response: User supplied callback function to call when response is received
recv_buf: User supplied buffer where received data is stored
recv_buf_len: Length of recv_buf

When the HTTP request is populated, we will send it using the API call http_client_req().

ret = http_client_req(sock, &req, 5000, "IPv4 PUT");

sock: Socket file descriptor of the socket connected to the HTTP server
req: Pointer to the HTTP request
timeout: Maximum timeout to wait for data
user_data: User specified data that is passed to the callback, can be used for instance to identify which HTTP request it is responding to

Define a response callback function

When populating the HTTP request, we provided a callback function to be called when a response to the HTTP request is received. This callback has the following signature

rsp: HTTP response information, of type struct http_response
final_data: Indicates whether data bufer contains all the data, can be either HTTP_DATA_MORE or HTTP_DATA_FINAL
user_data: User specified data, specified when calling http_client_req()

The HTTP response from the server has many members so let’s focus on the most important ones.

http_status: Textual description of the numeric HTTP status code, 3-digit integer code if valid HTTP response is given, 0 if null response
recv_buf: Where the HTTP response is stored, provided by the user
body_frag_start: Start address of the body contained in the HTTP response in recv_buf
body_frag_len: Length of the body contained in recv_buf

In the following response callback, we print which HTTP request the HTTP response is a response to, through the user_data field used when sending the HTTP request. Then the status of the HTTP response and if the reponse has a body, we want to print that as well.

static void response_cb(struct http_response *rsp,
                        enum http_final_call final_data,
                        void *user_data)
{	
	LOG_INF("Response to %s", (const char *)user_data);
	LOG_INF("Response status: %s", rsp->http_status);

	if (rsp->body_frag_len > 0) {
		char body_buf[rsp->body_frag_len];
		strncpy(body_buf, rsp->body_frag_start, rsp->body_frag_len);
		LOG_INF("Received: %s", body_buf);
	} 
}

Using HTTP with TLS

As opposed to the MQTT Library we covered in Lesson 4, the HTTP client library does not natively support implementing a TLS connection. We will do this by creating and configuring a TLS socket and passing it to the library.

This will be done using secure sockets and the TLS credentials subsystem in the Zephyr socket API. TLS credentials must be provisioned to the device using tls_credential_add() before they can be used with secure sockets.

After creating the socket, configure some TLS relevant configurations on the socket, using setsockopt(), which has the following signature

We want to configure the socket with the security tag used to store the certificate and the hostname of the server we are connecting to. These are the options TLS_SEC_TAG_LIST and TLS_HOSTNAME, which reside at the protocol level SOL_TLS.

HTTP server

At the time being, there is no dedicated HTTP server library. However, much of the HTTP client library APIs can be used to implement an HTTP server.

For an HTTP server, we do not need to create an HTTP request, however, we need to define the struct that holds HTTP requests. This struct will be passed on the function that responds to HTTP requests, by changing the state of an LED for example.

The HTTP request struct can be define as shown in the code snippet below.

struct http_req {
	struct http_parser parser;
	int socket;
	bool received_all;
	enum http_method method;
	const char *url;
	size_t url_len;
	const char *body;
	size_t body_len;
};

To parse incoming HTTP requests, we will need to use the HTTP parser library and link it to different functions corresponding to each part of the HTTP request being parsed. The parser function implementation would look like this:

static void parser_init(void)
{
	http_parser_settings_init(&parser_settings);

	parser_settings.on_body = on_body;
	parser_settings.on_headers_complete = on_headers_complete;
	parser_settings.on_message_begin = on_message_begin;
	parser_settings.on_message_complete = on_message_complete;
	parser_settings.on_url = on_url;
}

To set up the actual server functionality, we will use the function shown on the code snippet below

*sock = socket(bind_addr->sa_family, SOCK_STREAM, IPPROTO_TCP);
if (*sock < 0) {
	LOG_ERR("Failed to create TCP socket: %d", errno);
	return -errno;
}

int err = bind(*sock, bind_addr, bind_addrlen);
if (err < 0) {
	LOG_ERR("Failed to bind TCP socket %d", errno);
	return -errno;
}

err = listen(*sock, MAX_CLIENT_QUEUE);
if (err < 0) {
	LOG_ERR("Failed to listen on TCP socket %d", errno);
	return -errno;
}

This function handles three main processes; it creates a socket, binds the server to the socket’s address, and finally it starts listening for incoming messages at that socket.

Lastly, to be able to send requests to the HTTP server, we need to register the service to be advertised via DNS. This is done using the API call DNS_SD_REGISTER_TCP_SERVICE(), from the DNS Service Discovery API, which takes the following parameters

DNS_SD_REGISTER_TCP_SERVICE(http_server_sd, "httpserver", "_http", "local",		    DNS_SD_EMPTY_TXT, 80);

Then we can use the URL http://httpserver.local:80 to connect to the HTTP server on a local connection.

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, and obtain a certificate certifying completion of these courses. 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 details safe.

You will able to receive an electronic certificate from Nordic Developer Academy upon completion of courses. By issuing you such a certificate, Nordic Semiconductor certifies that you have completed the applicable course, but does not provide any further warrants or endorsements for any particular skills or professional qualifications.

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 https://academy.nordicsemi.com/terms-of-service/

‍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.

Wi-Fi Fundamentals

HTTP library

HTTP client library

Create an HTTP request

Define a response callback function

Using HTTP with TLS

HTTP server

Switch language?

Change summary

What's new in the latest version

Wi-Fi

MCUboot & Partition Manager