summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLeena Miettinen <riitta-leena.miettinen@qt.io>2019-04-15 16:06:37 +0200
committerLeena Miettinen <riitta-leena.miettinen@qt.io>2019-04-16 07:48:51 +0000
commitb4d8e5856cd0e7cb4ada3475242a433538418792 (patch)
tree812976d325cbcc8af99dfcf33851ad60f8159bff
parentbe0c505b4a948fcd634182b44f4dca0ec4772b36 (diff)
Add Qt CoAP module
Moved all external links to the external resources file. Change-Id: I785872c3b751a960250ce3e5ba4ea203e2781781 Sanity-Review: Qt Sanity Bot <qt_sanitybot@qt-project.org> Reviewed-by: Alex Blasche <alexander.blasche@qt.io> Reviewed-by: Sona Kurazyan <sona.kurazyan@qt.io> Reviewed-by: Maurice Kalinowski <maurice.kalinowski@qt.io>
-rw-r--r--src/external-resources.qdoc30
-rw-r--r--src/qtforautomation-project.qdocconf4
-rw-r--r--src/qtforautomation.qdoc28
3 files changed, 54 insertions, 8 deletions
diff --git a/src/external-resources.qdoc b/src/external-resources.qdoc
index 0f5f51c..b718f64 100644
--- a/src/external-resources.qdoc
+++ b/src/external-resources.qdoc
@@ -126,3 +126,33 @@
\externalpage https://doc.qt.io/QtOPCUA/index.html
\title Qt OPC UA
*/
+
+/*!
+ \externalpage https://doc.qt.io/QtCoAP/index.html
+ \title Qt CoAP
+*/
+
+/*!
+ \externalpage http://coap.technology/
+ \title CoAP
+*/
+
+/*!
+ \externalpage https://tools.ietf.org/html/rfc7252
+ \title RFC 7252
+*/
+
+/*!
+ \externalpage http://mqtt.org
+ \title MQTT
+*/
+
+/*!
+ \externalpage http://www.knx.org
+ \title KNX
+*/
+
+/*!
+ \externalpage https://opcfoundation.org/about/opc-technologies/opc-ua/
+ \title OPC UA
+*/
diff --git a/src/qtforautomation-project.qdocconf b/src/qtforautomation-project.qdocconf
index 03d6ffa..e101d46 100644
--- a/src/qtforautomation-project.qdocconf
+++ b/src/qtforautomation-project.qdocconf
@@ -25,10 +25,10 @@ qhp.QtForAutomation.subprojects.manual.selectors = manual
tagfile = qtforautomation.tags
# check dependencies, linking using external URLs for now
-depends += qtmqtt qtknx qtopcua
+depends += qtmqtt qtknx qtopcua qtcoap
# dependencies to Qt docs
-depends += qtdoc qtquickcontrols2 qtwebengine qtvirtualkeyboard qtquick qtserialbus
+depends += qtdoc qtquickcontrols qtwebengine qtvirtualkeyboard qtquick qtserialbus
buildversion = "Qt for Automation $QT_VER"
diff --git a/src/qtforautomation.qdoc b/src/qtforautomation.qdoc
index c528366..2e1c3d5 100644
--- a/src/qtforautomation.qdoc
+++ b/src/qtforautomation.qdoc
@@ -58,8 +58,9 @@
\section1 Related Information
\list
- \li \l {Qt MQTT}
+ \li \l {Qt CoAP}
\li \l {Qt KNX}
+ \li \l {Qt MQTT}
\li \l {Qt OPC UA}
\li \l {Qt for Device Creation}
\endlist
@@ -131,9 +132,24 @@
\QTA comes with additional modules for machine-to-machine communication
and building automation:
+ \b {Qt CoAP}
+
+ \l {CoAP}(Constrained Application Protocol) is a machine-to-machine (M2M)
+ web transfer protocol for use with constrained nodes and networks in the
+ Internet of Things (IoT). It is designed to easily interface with HTTP
+ for integration with the Web, while meeting specialized requirements such
+ as multicast support, very low overhead, and simplicity for constrained
+ environments.
+
+ \l {Qt CoAP} implements the client side of CoAP defined by \l{RFC 7252}.
+ Generally, CoAP is designed to use datagram-oriented transport such as UDP,
+ and therefore the current implementation of the transport is based on UDP.
+ However, it is also possible to implement custom transports based on TCP,
+ WebSocket, and so on.
+
\b {Qt MQTT}
- \l {http://mqtt.org}{MQTT} (Message Queue Telemetry Transport) is an extremely
+ \l {MQTT} (Message Queue Telemetry Transport) is an extremely
lightweight machine-to-machine (M2M) connectivity protocol utilizing the
publish-and-subscribe paradigm, and is suitable for carrying telemetry data
with minimal overhead.
@@ -144,8 +160,8 @@
\b {Qt KNX}
- \l {http://www.knx.org}{KNX} is a standard for controlling home and building
- management equipment, such as lighting, blinds and shutters, security systems,
+ \l {KNX} is a standard for controlling home and building management
+ equipment, such as lighting, blinds and shutters, security systems,
heating and energy management, and more.
\l {Qt KNX} implements the client side of a connection between a client and
@@ -156,8 +172,8 @@
\b {Qt OPC UA}
- \l {https://opcfoundation.org/about/opc-technologies/opc-ua/}{OPC UA} is a
- protocol for data modelling and exchange of data in industrial applications.
+ \l {OPC UA} is a protocol for data modelling and exchange of data in
+ industrial applications.
\l {Qt OPC UA} provides a means to interact with OPC UA servers on top of
third-party OPC UA stacks.