Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
Dependencies: NetServices FatFileSystem csv_parser mbed MQTTClient RF12B DNSResolver SDFileSystem
OutputMqtt Class Reference
Implementation of MQTT output class. More...
#include <OutputMqtt.h>
Public Member Functions | |
| OutputMqtt () | |
| Default Constructor. | |
| virtual bool | init () |
| Initialise output definition object. | |
| void | initConnection (IpAddr *serverIpAddr, short port, char *username, char *password) |
| Set the IP address of the host. | |
| virtual void | addReading (char *topic, char *unused, char *reading) |
| Add a character pointer reading to output. | |
| virtual int | send () |
| Send any collected readings Does nothing in MQTT as already published. | |
| virtual int | getSendCount () |
| Get the send count. | |
Detailed Description
Implementation of MQTT output class.
Definition at line 42 of file OutputMqtt.h.
Constructor & Destructor Documentation
| OutputMqtt | ( | ) |
Default Constructor.
IoT Gateway Output definition for MQTT.
LICENSE
Copyright (c) 2012 Andrew Lindsay (andrew [at] thiseldo [dot] co [dot] uk)
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
DESCRIPTION
Definition at line 36 of file OutputMqtt.cpp.
Member Function Documentation
| void addReading | ( | char * | topic, |
| char * | unused, | ||
| char * | reading | ||
| ) | [virtual] |
Add a character pointer reading to output.
- Parameters:
-
topic The topic to publish to unused Unused in this output reading The new value
Definition at line 69 of file OutputMqtt.cpp.
| int getSendCount | ( | void | ) | [virtual] |
| bool init | ( | ) | [virtual] |
Initialise output definition object.
Definition at line 57 of file OutputMqtt.cpp.
| void initConnection | ( | IpAddr * | serverIpAddr, |
| short | port, | ||
| char * | username, | ||
| char * | password | ||
| ) |
Set the IP address of the host.
- Parameters:
-
serverIpAddr IP Addres of host port Port to use username Username or NULL if not used password Password or NULL if not used
Definition at line 50 of file OutputMqtt.cpp.
| int send | ( | void | ) | [virtual] |
Send any collected readings Does nothing in MQTT as already published.
- Returns:
- -1 for fail, 1 for success
Definition at line 76 of file OutputMqtt.cpp.
Generated on Tue Jul 12 2022 22:07:04 by
1.7.2