#include <src/publishers/EnviroDIYPublisher.h>

EnviroDIYPublisher class

Base classes

class dataPublisher

The dataPublisher class is a virtual class used by other publishers to distribute data online.

Constructors, destructors, conversion operators

EnviroDIYPublisher()

Construct a new EnviroDIY Publisher object with no members set.

EnviroDIYPublisher(Logger& baseLogger, int sendEveryX = 1) explicit

Construct a new EnviroDIY Publisher object.

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

Construct a new EnviroDIY Publisher object.

EnviroDIYPublisher(Logger& baseLogger, const char* registrationToken, const char* samplingFeatureUUID, int sendEveryX = 1)

Construct a new EnviroDIY Publisher object.

EnviroDIYPublisher(Logger& baseLogger, Client* inClient, const char* registrationToken, const char* samplingFeatureUUID, int sendEveryX = 1)

Construct a new EnviroDIY Publisher object.

~EnviroDIYPublisher() virtual

Destroy the EnviroDIY Publisher object.

Public functions

String getEndpoint(void) -> String override

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

String getHost(void) -> String

Get the EnviroDIY/Monitor My Watershed web host.

void setHost(const char* host)

Set the EnviroDIY/Monitor My Watershed web host.

String getPath(void) -> String

Get the EnviroDIY/Monitor My Watershed API path.

void setPath(const char* endpoint)

Set the EnviroDIY/Monitor My Watershed API path.

int getPort(void) -> int

Get the EnviroDIY/Monitor My Watershed API port.

void setPort(int port)

Set the EnviroDIY/Monitor My Watershed API port.

void setToken(const char* registrationToken)

Set the site registration token.

uint16_t calculateJsonSize() -> uint16_t

Calculates how long the outgoing JSON will be.

void begin(Logger& baseLogger, Client* inClient, const char* registrationToken, const char* samplingFeatureUUID)

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

void begin(Logger& baseLogger, const char* registrationToken, const char* samplingFeatureUUID)

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

int16_t publishData(Client* outClient) -> int16_t override

Utilize an attached modem to open a a TCP connection to the EnviroDIY/ODM2DataSharingPortal and then stream out a post request over that connection.

Portions of the POST request to EnviroDIY

const char* enviroDIYPath protected

The api path.

const char* enviroDIYHost protected

The host name.

int enviroDIYPort protected

The host port.

static const char* tokenHeader protected

The token header text.

static const char* contentLengthHeader protected

The content length header text.

static const char* contentTypeHeader protected

The content type header text.

Portions of the JSON object for EnviroDIY

static const char* samplingFeatureTag protected

The JSON feature UUID tag.

static const char* timestampTag protected

The JSON feature timestamp tag.

Function documentation