#include <src/publishers/AWS_IoT_Publisher.h>

AWS_IoT_Publisher class

AWS_IoT_Publisher::AWS_IoT_Publisher(Logger& baseLogger, int sendEveryX = 1) explicit

Construct a new AWS IoT Core Publisher object.

AWS_IoT_Publisher::AWS_IoT_Publisher(Logger& baseLogger, Client* inClient, int sendEveryX = 1)

Construct a new AWS IoT Core Publisher object.

AWS_IoT_Publisher::AWS_IoT_Publisher(Logger& baseLogger, const char* awsIoTEndpoint, const char* caCertName, const char* clientCertName, const char* clientKeyName, const char* samplingFeatureUUID, int sendEveryX = 1)

Construct a new AWS IoT Core Publisher object.

AWS_IoT_Publisher::AWS_IoT_Publisher(Logger& baseLogger, const char* awsIoTEndpoint, const char* caCertName, const char* clientCertName, const char* clientKeyName, int sendEveryX = 1)

Construct a new AWS IoT Core Publisher object.

AWS_IoT_Publisher::AWS_IoT_Publisher(Logger& baseLogger, Client* inClient, const char* awsIoTEndpoint, const char* samplingFeatureUUID, int sendEveryX = 1)

Construct a new AWS IoT Core Publisher object.

String AWS_IoT_Publisher::getEndpoint(void) override

Get the destination for published data - generally the host name of the data receiver.

void AWS_IoT_Publisher::setEndpoint(const char* awsIoTEndpoint)

Set the endpoint for your AWS IoT instance.

Get the broker host/endpoint from AWS IoT Core > Connect > Domain Configurations. The endpoint will be something like "xxx-ats.iot.your-region.amazonaws.com".

void AWS_IoT_Publisher::setCACertName(const char* caCertName)

Set the name of your certificate authority certificate file.

You MUST have already uploaded your certificate to your modem. This will most likely be the Amazon Root CA 1 (RSA 2048 bit key) certificate. You can find Amazon's current CA certificates here: https://docs.aws.amazon.com/iot/latest/developerguide/server-authentication.html. Depending on your module, you may instead need a certificate chain file or to use Amazon's older top-chain certificate (Starfield Services Root Certificate Authority - G2).

This is exactly the same CA certificate as you would use to upload to S3 (ie, the S3 Presigned Publisher). For supported modules you can use the AWS_IOT_SetCertificates sketch in the extras folder to upload your certificate.

void AWS_IoT_Publisher::setClientCertName(const char* clientCertName)

Set the name of your client certificate file.

You MUST have already uploaded your certificate to your modem. You must download the certificate when you create it. Your certificate should be tied to a security policy that allows connection, publishing, and subscribing by thing name.

For supported modules you can use the AWS_IOT_SetCertificates sketch in the extras folder to upload your certificate.

void AWS_IoT_Publisher::setClientKeyName(const char* clientKeyName)

Set the name of your client private key file.

You MUST have have already uploaded your certificate to your modem. You must download the certificate when you create it. Your certificate should be tied to a security policy that allows connection, publishing, and subscribing by thing name.

For supported modules you can use the AWS_IOT_SetCertificates sketch in the extras folder to upload your certificate.

void AWS_IoT_Publisher::setAWSIoTParams(const char* awsIoTEndpoint, const char* caCertName, const char* clientCertName, const char* clientKeyName)

Sets all of the AWS IoT Core parameters.

void AWS_IoT_Publisher::setDataPublishTopic(const char* topic)

Set the topic to use for publishing data.

If not specified, the topic "{LoggerID}/{SamplingFeatureUUID}" will be used.

Make sure you have IAM policies set up to allow your device to publish to the specified topic!

void AWS_IoT_Publisher::setMetadataPublishTopic(const char* topic)

Set the topic to use for publishing metadata.

If not specified, the topic "{LoggerID}/metadata" will be used for the main logger metadata. For each variable, the variable number will be appended to the topic (ie, "{LoggerID}/metadata/variable01").

Make sure you have IAM policies set up to allow your device to publish to the specified topics!

void AWS_IoT_Publisher::addSubTopic(const char* topic)

Adds a topic to subscribe to.

When publishing data, the publisher will subscribe to the topic.

void AWS_IoT_Publisher::removeSubTopic(const char* topic)

Removes a topic from the subscription list.

I don't expect this to be used, but I'm adding it just in case.

void AWS_IoT_Publisher::addPublishRequest(const char* topic, String(*)(void) contentGetrFxn)

Adds a topic to subscribe to.

When publishing data, the publisher will subscribe to the topic.

void AWS_IoT_Publisher::removePublishRequest(const char* topic)

Removes a topic from the publish list.

PubSubClient& AWS_IoT_Publisher::setCallback(MQTT_CALLBACK_SIGNATURE )

A passthrough to the PubSubClient setCallback function; sets a function to call back when data is received on any of the subscribed topics.

This must be a static or main level function! It cannot be a member function of a class! Your callback function should call this publishers AWS_IoT_Publisher::closeConnection() method immediately after getting your desired response to stop the publisher from waiting for more messages.

void AWS_IoT_Publisher::begin(Logger& baseLogger, Client* inClient, const char* awsIoTEndpoint, const char* samplingFeatureUUID)

Begin the publisher - linking it to the client and logger.

This can be used as an alternative to adding the logger and client in the constructor.

void AWS_IoT_Publisher::begin(Logger& baseLogger, Client* inClient, const char* awsIoTEndpoint)

Begin the publisher - linking it to the client and logger.

This can be used as an alternative to adding the logger and client in the constructor.

void AWS_IoT_Publisher::begin(Logger& baseLogger, const char* awsIoTEndpoint, const char* caCertName, const char* clientCertName, const char* clientKeyName, const char* samplingFeatureUUID)

Begin the publisher - linking it to the logger but not attaching a client.

This can be used as an alternative to adding the logger and client in the constructor.

void AWS_IoT_Publisher::begin(Logger& baseLogger, const char* awsIoTEndpoint, const char* caCertName, const char* clientCertName, const char* clientKeyName)

Begin the publisher - linking it to the logger but not attaching a client.

This can be used as an alternative to adding the logger and client in the constructor.

int16_t AWS_IoT_Publisher::publishData(Client* outClient, bool forceFlush = false) override

Utilize an attached modem to open a SSL connection to AWS IoT Core and publish data over that connection.

This depends on an internet connection already having been made and a client being available.

int16_t AWS_IoT_Publisher::publishMetadata(Client* outClient) override

Open a socket to the correct receiver and send out metadata about the current logger setup.

This is to be used only when the logger is starting up! As the metadata doesn't generally change after start up, there's no reason to call this function any other time. There is no sensor data included in this metadata! If there is metadata that has to be included with each data post, that should be included in the publishData function. Because there is no sensor data included in this metadata and it's only to be called at boot, there's no forceFlush option for this function.

This depends on an internet connection already having been made and a client being available.

Client* AWS_IoT_Publisher::createClient() override protected

Use the connected base logger's logger modem and underlying TinyGSM instance to create a new client for the publisher.

void AWS_IoT_Publisher::deleteClient(Client* client) override protected

Delete a created client. We need to pass this through to avoid a memory leak because we cannot delete from the pointer because the destructor for a client in the Arduino core isn't virtual.