README.md 1.9 KB
Newer Older
1
# Eclipse Paho MQTT C/C++ client for Embedded platforms
I
Ian Craggs 已提交
2

I
Ian Craggs 已提交
3 4 5
This repository contains the source code for the [Eclipse Paho](http://eclipse.org/paho) MQTT C/C++ client library for Embedded platorms.

It is dual licensed under the EPL and EDL (see about.html and notice.html for more details).  You can choose which of these licenses you want to use the code under.  The EDL allows you to embed the code into your application, and distribute your application in binary or source form without contributing any of your code, or any changes you make back to Paho.  See the EDL for the exact conditions.
6 7 8 9 10 11

The MQTTPacket directory contains the lowest level C library with the smallest requirements.  This supplies simple serialization 
and deserialization routines.  It is mainly up to you to write and read to and from the network.

The MQTTClient directory contains the next level C++ library.  This still avoids most networking code so that you can plugin the
network of your choice.
I
Ian Craggs 已提交
12 13 14

## Build requirements / compilation

I
Ian Craggs 已提交
15
There are helper scripts (build...) in various directories.  The client library is a set of building blocks which you pick and choose from, so that the smallest MQTT application can be built.
I
Ian Craggs 已提交
16 17 18

## Usage and API

I
Ian Craggs 已提交
19
See the samples directory for examples of intended use.
I
Ian Craggs 已提交
20 21 22 23


## Runtime tracing

I
Ian Craggs 已提交
24
As yet, there is no tracing.  For the smallest client, should we have tracing?
I
Ian Craggs 已提交
25 26 27 28


## Reporting bugs

29
Please report bugs under the "MQTT-Embedded-C" Component in [Eclipse Bugzilla](http://bugs.eclipse.org/bugs/) for the Paho Technology project.
I
Ian Craggs 已提交
30 31 32 33 34 35 36 37

## More information

Discussion of the Paho clients takes place on the [Eclipse paho-dev mailing list](https://dev.eclipse.org/mailman/listinfo/paho-dev).

General questions about the MQTT protocol are discussed in the [MQTT Google Group](https://groups.google.com/forum/?hl=en-US&fromgroups#!forum/mqtt).

There is much more information available via the [MQTT community site](http://mqtt.org).