Directories and Files

This section discusses the modules available for μC/MQTT-client, and how they all fit together. A Windows®-based development platform is assumed. The directories and files make references to typical Windows-type directory structures. However, since μC/MQTT-client is available in source form, it can also be used with any ANSI-C compatible compiler/linker and Operating System.

Below is a summary of all directories and files involved in the µC/MQTT-client module. The ‘<-Cfg’ on the right indicates that these files are typically copied into the application (i.e. project) directory and edited based on project requirements.

\Micrium
    \Software
        \uC-MQTT
			\Client
 				\Cfg
                	\Template
                    	\mqtt-c_cfg.h              <-Cfg
  				\Examples
      
                \Source
	                \mqtt-c.c
                	\mqtt-c.h
					\mqtt-c_sock.c
					\mqtt-c_sock.h
            \Common
                mqtt.h

Client

The "Client" directory inside µC/MQTT contains all files relative to the µC/MQTT-client product.

Configuration

The "Cfg" directory includes a template configuration file that can be copied to the application directory and modified according to the application needs.

Examples

This directory contains example codes to help you get started with the µC/MQTT-client product.

Source Code

This is the directory that contains all the CPU and RTOS independent source code files for µC/MQTT-client.

mqtt-c.c/h contains the API function declarations and definitions.

Common

The "Common" directory contains files that are common to both the MQTT Client and possibly a Server too, which is not available.