This section describes all the steps required to build a HTTPs-based application. The instructions provided in this section are not intended for any particular toolchain, but instead are described in a generic way that can be adapted to any toolchain.
The best way to start building a HTTPs-based project is to start from an existing project. If you are using µC/OS-II or µC/OS-III, Micrium provides example projects for multiple development boards and compilers. If your target board is not listed on Micrium’s web site, you can download an example project for a similar board or microcontroller.
If you are starting from a Micriµm example, section µC/HTTPs Project Example gives more details on the Micriµm example repository and included files.
Working project with RTOS
The first step before including the µC/HTTPs is to have a working project with the RTOS of your choice. As previously mentioned, Micriµm offers starting example with the µC/OS-II and µC/OS-III kernels for many evalboards.
Complete documentation for µC/OS-II here, including a Getting Started Guide.
Complete documentation for µC/OS-III here, including a Getting Started Guide.
Including Additional Modules to the Project
Once you have a working project with your RTOS, additional modules are needed by the Micriµm HTTP server that are not necessarily already included in your project. Therefore, be sure to add µC/CPU, µC/LIB, µC/Common and µC/TCPIP to your project.
Complete documentation for µC/CPU here.
Complete documentation for µC/LIB here.
Complete documentation for µC/Common here.
Complete documentation for µC/TCPIP here.
Bear in mind to include the required paths associated with those modules to your project’s C compiler settings.
Including HTTP Server Source Code
Include the following files in your project tree from the µC/HTTPs source code distribution, as indicated in Figure - µC/HTTPs Source Code.
As indicated in the Figure - µC/TCP-IP Source Code, all the files in the Source folder must be added to your project tree. Furthermore, if a TCP-IP port exists for your CPU architecture inside the "Ports" folder, you can also include it to your project files.
Second, add the following include paths to your project’s C compiler settings:
\Micrium\Software\uC-TCPIP
\Micrium\Software\uC-TCPIP\Dev\Ether\<device_name>
\Micrium\Software\uC-TCPIP\Dev\Ether\PHY\<phy_device_name>
Tasks Priority
The net_cfg.c file includes the three network task configurations. You will need to defined the priority of each of those tasks. The priorities will depend on the other tasks already present in your application. Refer to section Network Tasks Configuration for all the details on configuring the network tasks and their priority.
Sample Project Setup
The purpose of this sample project is to setup a network host on the target board to allow it to communicate with other hosts on the network. Figure - Sample Application Setup shows the project test setup for a Ethernet wired interface. The target board is wire-connected to an Ethernet switch or via an Ethernet cross-over cable to a Windows-based PC. The PC’s IP address is set to 10.10.10.111 and the target’s addresses will be configure to 10.10.10.64 as it will be shown in the next section Adding µC/TCP-IP application function.
This sample project contains enough code to be able to ping the board. Therefore, after successfully running the project, You will be able to issue the following command form a command-prompt:
ping 10.10.10.64
Ping (on the PC) should reply back with the ping time to the target. µC/TCP-IP target projects connected to the test PC on the same Ethernet switch or Ethernet cross-over cable achieve ping times of less than 2 milliseconds.After you have successfully completed and run the sample project, you can use it as a starting point to run other µC/TCP-IP demos you may have purchased.
Adding Additional includes
Since the µC/TCP-IP module was added to the sample project, the following include must be added to the app.c file :
#include <KAL/kal.h>
#include <Source/net.h>
#include <net_dev_????.h>
#include <net_phy_????.h>
#include <net_dev_cfg.h>
#include <net_bsp.h>
Adding µC/TCP-IP application function
Before running the sample application, you will need to add the new funtion, AppInit_TCPIP(), in your app.c file to initialize and setup the µC/TCP-IP stack. Section Tasks and Objects Initialization gives an example of the main application task inside which the AppInit_TCPIP() function will be called. Section Ethernet Sample Application gives an AppInit_TCPIP() example for a wired Ethernet interface.
Those code examples will need to be modified in accordance with your project setup. For example, when adding an interface, your network device configuration object name (inside net_dev_cfg.c) will need to be specify and the IP address used in the example could need to be change to match your network.
Once the source code is built and loaded into the target, the target will respond to ICMP Echo (ping) requests.
Copying and Modifying Template Files
Copy the files from the uC-TCPIP configuration folder into your application as illustrated in Figure - Copying Template Files.
net_cfg.c is a configuration file including the NET_TASK_CFG objects used to configured the µC/TCP-IP internal tasks. The µC/TCP-IP stack has three internal tasks : the Receive task, the Transmit De-allocation task and the Timer task. Each task as its own NET_TASK_CFG object defining the task priority, the task's stack size and the pointer to start of task stack. Refer to section Network Tasks Configuration for more details on the µC/TCP-IP tasks configuration.
net_cfg.h is a configuration file used to setup µC/TCP-IP stack static parameters such as the number of available sockets, TCP connections and network timers, the ARP and NDP parameters, the number of configurable interface and so on. Refer to section Static Stack Configuration for more details on all the configurations inside net_cfg.h
net_dev_cfg.c and net_dev_cfg.h are configuration files used to set the wired or wireless device interface parameters such as the number and size of network buffers available for transmission and reception and the base address of the device's registers. They also include the PHY parameters such as the PHY bus mode (RMII or MII) in the case of a wired Ethernet device.
Since the device configuration is different depending if your interface is wired or wireless, the details on the device configuration modifications will be shown in the corresponding sub-sections.
Modifying the Application Configuration Files
The µC/TCP-IP stack uses additional heap memory space. Therefore, it is possible that your sample application will require more allocation of heap memory. If ti is the case, you can increase the value of the #define LIB_MEM_CFG_HEAP_SIZE inside the lib_cfg.h file of your sample project. You can refer to section µC/LIB Memory Heap Configuration for more details on the heap usage of the µC/TCP-IP stack.
DEVELOP