Merge pull request #41 from OS2iot/feature/docs-for-mqtt-support

Correct renaming in docs

Author: fcv-iteratorIt

source/external-interface-design/external-interface-design.rst

@@ -313,35 +313,35 @@ over the network by a device.
 MQTT
 ^^^^
 
-There are two kinds of MQTT devices available. MQTT-publisher and MQTT-subscriber. These two devices works in different matters which will be described below.
+There are two kinds of MQTT devices available. MQTT external broker and MQTT internal broker. These two devices works in different matters which will be described below.
 
-MQTT-publisher
+MQTT external broker
 ~~~~~~~~~~~~~~
-The MQTT-publisher device will make it possible for a physical device to communicate with the internal OS2IoT mosquitto broker.
-The MQTT-publisher is created in the OS2IoT backend and is created with the credentials that the device needs for communicating with the internal broker.
+The MQTT external broker device will make it possible for a physical device to communicate with the internal OS2IoT mosquitto broker.
+The MQTT external broker is created in the OS2IoT backend and is created with the credentials that the device needs for communicating with the internal broker.
 
-The MQTT-publisher device can either be created with username/password or credentials. If the publisher is created with username/password it will use port 8885, and if created with certificate it will use port 8884.
+The MQTT external broker device can either be created with username/password or credentials. If the publisher is created with username/password it will use port 8885, and if created with certificate it will use port 8884.
 
 When a physical MQTT device will publish some data, then OS2IoT will check for the specific topic that the device is publishing to in the database, and if the topic is set in the database, it will process the data.
-If a MQTT-publisher device with the specific topic isn't created then the broker won't be able to find it in the database and therefore it will reject the data.
+If a MQTT external broker device with the specific topic isn't created then the broker won't be able to find it in the database and therefore it will reject the data.
 
 The specific topic for the created device will be :code:`device/organizationID/applicationID/deviceID`.
 
 
 
 
-MQTT-subscriber
+MQTT internal broker
 ~~~~~~~~~~~~~~~
 
-The MQTT-subscriber uses the MQTT protocol to subscribe to a topic on an external MQTT broker. A client is created in the OS2IoT backend.
+The MQTT internal broker uses the MQTT protocol to subscribe to a topic on an external MQTT broker. A client is created in the OS2IoT backend.
 This client will connect to the external MQTT broker using the provided URL, port and authentication, and then subscribe to data on the provided topic.
 
 OS2IoT doesn't have any knowlegde of the external broker so it's totally up to the user to provide the different inputs.
 If the input isn't valid and a connection can't be made to the external broker, a flag will be set in the database which tells OS2IoT that the connection can't be made and then OS2IoT will stop trying to connect to the external broker.
 
 If the inputs from the user IS valid, then a connection will be made and the device will listen to any updates from the broker.
 
-The MQTT-subscriber device has the possibility to use either certificate or username/password to a external broker if needed.
+The MQTT internal broker device has the possibility to use either certificate or username/password to a external broker if needed.
 
 
 Sigfox

source/iot-data-handling/iot-data-handling.rst

@@ -62,24 +62,24 @@ If the API-key is unknown, then the resposne will be 403 Bad Request with the me
 MQTT
 ^^^^
 
-OS2IoT supports two kinds of MQTT devices. An MQTT-publisher and an MQTT-subscriber. 
+OS2IoT supports two kinds of MQTT devices. An MQTT external broker and an MQTT internal broker. 
 
 OS2IoT supports two kinds of authorization for MQTT devices: Username/password and certificate.
 
-MQTT-publisher
+MQTT external broker
 ~~~~~~~~~~~~~~
 
-When an MQTT-publisher is created, the credentials for connecting to the internal MQTT-broker are generated. 
+When an MQTT external broker is created, the credentials for connecting to the internal MQTT-broker are generated. 
 These consists of a URL, a port and a topic for the device to send data to. 
 If the authorization type is certificate then the required certificates will be generated. If username/password is used these are manually entered.
 
-When a known MQTT-publisher sends data to the topic assigned to it, the message will be further processed. 
+When a known MQTT external broker sends data to the topic assigned to it, the message will be further processed. 
 If a device attempts to send to a different topic the message will be discarded.
 
-MQTT-subscriber
+MQTT internal broker
 ~~~~~~~~~~~~~~~
 
-When an MQTT-subscriber is created a connection to the external broker is made using the entered credentials. 
+When an MQTT internal broker is created a connection to the external broker is made using the entered credentials. 
 When a message is received by the external broker on the topic configured, OS2IoT will also receive the message and further process it.
 
 

source/logical-data-model/logical-datamodel.rst

@@ -103,8 +103,8 @@ IoTDeviceType
 1. GenericHttp
 2. LoRaWAN
 3. SigFox
-4. MQTTBroker
-5. MQTTSubscriber
+4. MQTTInternalBroker
+5. MQTTExternalBroker
 
 ErrorCodes 
 ~~~~~~~~~~~~~~~~~

source/software-architecture/software-architecture.rst

@@ -332,14 +332,14 @@ It is required that the device itself can be configured to send to a configured
 MQTT
 ^^^^
 
-The MQTT Broker devices is communicating with the internal MQTT broker with encrypted TLS. The broker is futhermore implemented with the go-auth plugin (https://github.com/iegomez/mosquitto-go-auth).
+The MQTT internal Broker devices is communicating with the internal MQTT broker with encrypted TLS. The broker is futhermore implemented with the go-auth plugin (https://github.com/iegomez/mosquitto-go-auth).
 
 The go-auth plugin is used so that devices trying to communicating with the internal MQTT broker has to be verified in the database by sending their username and password or by sending a device certificate that only can be verified if it's signed by the CA certificate. 
 If the internal MQTT broker can't verify the device trying to connect then the internal MQTT broker will close the connection for the device.
 
 The internal MQTT broker is also checking if the device trying to publish or subscribe to the broker has access to the specific topic that the device is trying to publish or subscribe to.
 
-The MQTT Client devices can support both username/password and cert authentication if a broker requires it.
+The MQTT external broker devices can support both username/password and cert authentication if a broker requires it.
 
 Sigfox
 ^^^^^^