ArduinoIoTCloudTCP.h

/*
   This file is part of ArduinoIoTCloud.

   Copyright 2019 ARDUINO SA (http://www.arduino.cc/)

   This software is released under the GNU General Public License version 3,
   which covers the main part of arduino-cli.
   The terms of this license can be found at:
   https://www.gnu.org/licenses/gpl-3.0.en.html

   You can be released from the requirements of the above licenses by purchasing
   a commercial license. Buying such a license is mandatory if you want to modify or
   otherwise use the software for commercial activities involving the Arduino
   software without disclosing the source code of your own applications. To purchase
   a commercial license, send an email to license@arduino.cc.
*/

#ifndef ARDUINO_IOT_CLOUD_TCP_H
#define ARDUINO_IOT_CLOUD_TCP_H

/******************************************************************************
 * INCLUDE
 ******************************************************************************/

#include <AIoTC_Config.h>
#include <ArduinoIoTCloud.h>
#include <ArduinoMqttClient.h>
#include <utility/time/TimedAttempt.h>

#if defined(BOARD_HAS_SECURE_ELEMENT)
  #include <Arduino_SecureElement.h>
  #include <utility/SElementArduinoCloudDeviceId.h>
  #if !defined(BOARD_HAS_OFFLOADED_ECCX08)
    #include <utility/SElementArduinoCloudCertificate.h>
  #endif
#endif

#if defined(BOARD_HAS_OFFLOADED_ECCX08)
  #include "WiFiSSLClient.h"
#elif defined(BOARD_HAS_ECCX08)
  #include "tls/BearSSLClient.h"
#elif defined(ARDUINO_PORTENTA_C33)
  #include <SSLClient.h>
#elif defined(ARDUINO_NICLA_VISION)
  #include <WiFiSSLSE050Client.h>
#elif defined(ARDUINO_EDGE_CONTROL)
  #include <GSMSSLClient.h>
#elif defined(ARDUINO_UNOR4_WIFI)
  #include <WiFiSSLClient.h>
#elif defined(BOARD_ESP)
  #include <WiFiClientSecure.h>
#endif

/******************************************************************************
   CONSTANTS
 ******************************************************************************/
static char const DEFAULT_BROKER_ADDRESS_SECURE_AUTH[] = "iot.arduino.cc";
static uint16_t const DEFAULT_BROKER_PORT_SECURE_AUTH = 8883;
static uint16_t const DEFAULT_BROKER_PORT_USER_PASS_AUTH = 8884;

/******************************************************************************
 * TYPEDEF
 ******************************************************************************/

typedef bool (*onOTARequestCallbackFunc)(void);

/******************************************************************************
 * CLASS DECLARATION
 ******************************************************************************/

class ArduinoIoTCloudTCP: public ArduinoIoTCloudClass
{
  public:

             ArduinoIoTCloudTCP();
    virtual ~ArduinoIoTCloudTCP() { }


    virtual void update        () override;
    virtual int  connected     () override;
    virtual void printDebugInfo() override;

    int begin(ConnectionHandler & connection, bool const enable_watchdog = true, String brokerAddress = DEFAULT_BROKER_ADDRESS_SECURE_AUTH, uint16_t brokerPort = DEFAULT_BROKER_PORT_SECURE_AUTH);
    int begin(bool const enable_watchdog = true, String brokerAddress = DEFAULT_BROKER_ADDRESS_SECURE_AUTH, uint16_t brokerPort = DEFAULT_BROKER_PORT_SECURE_AUTH);

    #ifdef BOARD_HAS_SECRET_KEY
    inline void setBoardId        (String const device_id) { setDeviceId(device_id); }
    inline void setSecretDeviceKey(String const password)  { _password = password;  }
    #endif

    inline String   getBrokerAddress() const { return _brokerAddress; }
    inline uint16_t getBrokerPort   () const { return _brokerPort; }

    inline PropertyContainer &getThingPropertyContainer() { return _thing_property_container; }

#if OTA_ENABLED
    /* The callback is triggered when the OTA is initiated and it gets executed until _ota_req flag is cleared.
     * It should return true when the OTA can be applied or false otherwise.
     * See example ArduinoIoTCloud-DeferredOTA.ino
     */
    void onOTARequestCb(onOTARequestCallbackFunc cb) {
      _get_ota_confirmation = cb;
      _ask_user_before_executing_ota = true;
    }

    void handle_OTARequest();
#endif

  private:
    static const int MQTT_TRANSMIT_BUFFER_SIZE = 256;

    enum class State
    {
      ConnectPhy,
      SyncTime,
      ConnectMqttBroker,
      SendDeviceProperties,
      SubscribeDeviceTopic,
      CheckDeviceConfig,
      SubscribeThingTopics,
      RequestLastValues,
      Connected,
      Disconnect,
    };

    State _state;
    TimedAttempt _connection_attempt;
    PropertyContainer _device_property_container;
    PropertyContainer _thing_property_container;
    unsigned int _last_checked_property_index;

    int _tz_offset;
    Property * _tz_offset_property;
    unsigned int _tz_dst_until;
    Property * _tz_dst_until_property;

    String _brokerAddress;
    uint16_t _brokerPort;
    uint8_t _mqtt_data_buf[MQTT_TRANSMIT_BUFFER_SIZE];
    int _mqtt_data_len;
    bool _mqtt_data_request_retransmit;

#if defined(BOARD_HAS_SECRET_KEY)
    String _password;
#endif

#if defined(BOARD_HAS_SECURE_ELEMENT)
    SecureElement _selement;
  #if !defined(BOARD_HAS_OFFLOADED_ECCX08)
    ECP256Certificate _cert;
  #endif
#endif

#if defined(BOARD_HAS_OFFLOADED_ECCX08)
    WiFiBearSSLClient _sslClient;
#elif defined(BOARD_HAS_ECCX08)
    BearSSLClient _sslClient;
#elif defined(ARDUINO_PORTENTA_C33)
    SSLClient _sslClient;
#elif defined(ARDUINO_NICLA_VISION)
    WiFiSSLSE050Client _sslClient;
#elif defined(ARDUINO_EDGE_CONTROL)
    GSMSSLClient _sslClient;
#elif defined(ARDUINO_UNOR4_WIFI)
    WiFiSSLClient _sslClient;
#elif defined(BOARD_ESP)
    WiFiClientSecure _sslClient;
#endif

    MqttClient _mqttClient;

    String _deviceTopicOut;
    String _deviceTopicIn;
    String _shadowTopicOut;
    String _shadowTopicIn;
    String _dataTopicOut;
    String _dataTopicIn;

#if OTA_ENABLED
    bool _ota_cap;
    int _ota_error;
    String _ota_img_sha256;
    String _ota_url;
    bool _ota_req;
    bool _ask_user_before_executing_ota;
    onOTARequestCallbackFunc _get_ota_confirmation;
#endif /* OTA_ENABLED */

    inline String getTopic_deviceout() { return String("/a/d/" + getDeviceId() + "/e/o");}
    inline String getTopic_devicein () { return String("/a/d/" + getDeviceId() + "/e/i");}
    inline String getTopic_shadowout() { return ( getThingId().length() == 0) ? String("") : String("/a/t/" + getThingId() + "/shadow/o"); }
    inline String getTopic_shadowin () { return ( getThingId().length() == 0) ? String("") : String("/a/t/" + getThingId() + "/shadow/i"); }
    inline String getTopic_dataout  () { return ( getThingId().length() == 0) ? String("") : String("/a/t/" + getThingId() + "/e/o"); }
    inline String getTopic_datain   () { return ( getThingId().length() == 0) ? String("") : String("/a/t/" + getThingId() + "/e/i"); }

    State handle_ConnectPhy();
    State handle_SyncTime();
    State handle_ConnectMqttBroker();
    State handle_SendDeviceProperties();
    State handle_CheckDeviceConfig();
    State handle_SubscribeDeviceTopic();
    State handle_SubscribeThingTopics();
    State handle_RequestLastValues();
    State handle_Connected();
    State handle_Disconnect();

    static void onMessage(int length);
    void handleMessage(int length);
    void sendPropertyContainerToCloud(String const topic, PropertyContainer & property_container, unsigned int & current_property_index);
    void sendThingPropertiesToCloud();
    void sendDevicePropertiesToCloud();
    void requestLastValue();
    int write(String const topic, byte const data[], int const length);

#if OTA_ENABLED
    void sendDevicePropertyToCloud(String const name);
#endif

    void updateThingTopics();
};

/******************************************************************************
 * EXTERN DECLARATION
 ******************************************************************************/

extern ArduinoIoTCloudTCP ArduinoCloud;

#endif