Provision.h

Go to the documentation of this file.

#ifndef Provision_h
#define Provision_h
 
// Local includes.
#include "Provision_Callback.h"
#include "IAPI_Implementation.h"
 
 
// Provision topics.
char constexpr PROV_RESPONSE_TOPIC[] = "/provision/response";
char constexpr PROV_REQUEST_TOPIC[] = "/provision/request";
// Provision data keys.
char constexpr DEVICE_NAME_KEY[] = "deviceName";
char constexpr PROV_DEVICE_KEY[] = "provisionDeviceKey";
char constexpr PROV_DEVICE_SECRET_KEY[] = "provisionDeviceSecret";
char constexpr PROV_CRED_TYPE_KEY[] = "credentialsType";
char constexpr PROV_TOKEN[] = "token";
char constexpr PROV_CRED_USERNAME[] = "username";
char constexpr PROV_CRED_PASSWORD[] = "password";
char constexpr PROV_CRED_CLIENT_ID[] = "clientId";
char constexpr PROV_CRED_HASH[] = "hash";
 
 
template <typename Logger = DefaultLogger>
class Provision : public IAPI_Implementation {
  public:
    Provision() = default;
 
    ~Provision() override = default;
 
    bool Provision_Request(Provision_Callback const & callback) {
        char const * provision_device_key = callback.Get_Device_Key();
        char const * provision_device_secret = callback.Get_Device_Secret();
 
        if (Helper::String_IsNull_Or_Empty(provision_device_key) || Helper::String_IsNull_Or_Empty(provision_device_secret)) {
            return false;
        }
        else if (!Provision_Subscribe(callback)) {
            return false;
        }
 
        StaticJsonDocument<JSON_OBJECT_SIZE(9)> request_buffer;
        char const * device_name = callback.Get_Device_Name();
        char const * access_token = callback.Get_Device_Access_Token();
        char const * cred_username = callback.Get_Credentials_Username();
        char const * cred_password = callback.Get_Credentials_Password();
        char const * cred_client_id = callback.Get_Credentials_Client_ID();
        char const * hash = callback.Get_Certificate_Hash();
        char const * credentials_type = callback.Get_Credentials_Type();
 
        // Deciding which underlying provisioning method is restricted, by the Provision_Callback class.
        // Meaning only the key-value pairs that are needed for the given provisioning method are set,
        // resulting in the rest not being sent and therefore the provisioning request having the correct formatting
        if (!Helper::String_IsNull_Or_Empty(device_name)) {
            request_buffer[DEVICE_NAME_KEY] = device_name;
        }
        if (!Helper::String_IsNull_Or_Empty(access_token)) {
            request_buffer[PROV_TOKEN] = access_token;
        }
        if (!Helper::String_IsNull_Or_Empty(cred_username)) {
            request_buffer[PROV_CRED_USERNAME] = cred_username;
        }
        if (!Helper::String_IsNull_Or_Empty(cred_password)) {
            request_buffer[PROV_CRED_PASSWORD] = cred_password;
        }
        if (!Helper::String_IsNull_Or_Empty(cred_client_id)) {
            request_buffer[PROV_CRED_CLIENT_ID] = cred_client_id;
        }
        if (!Helper::String_IsNull_Or_Empty(hash)) {
            request_buffer[PROV_CRED_HASH] = hash;
        }
        if (!Helper::String_IsNull_Or_Empty(credentials_type)) {
            request_buffer[PROV_CRED_TYPE_KEY] = credentials_type;
        }
        request_buffer[PROV_DEVICE_KEY] = provision_device_key;
        request_buffer[PROV_DEVICE_SECRET_KEY] = provision_device_secret;
        auto & request_callback = m_provision_callback.Get_Request_Timeout();
        request_callback.Start_Timeout_Timer();
        return m_send_json_callback.Call_Callback(PROV_REQUEST_TOPIC, request_buffer);
    }
 
    API_Process_Type Get_Process_Type() const override {
        return API_Process_Type::JSON;
    }
 
    void Process_Response(char const * topic, uint8_t * payload, uint32_t length) override {
        // Nothing to do
    }
 
    void Process_Json_Response(char const * topic, JsonDocument const & data) override {
        auto & request_callback = m_provision_callback.Get_Request_Timeout();
        request_callback.Stop_Timeout_Timer();
        m_provision_callback.Call_Callback(data);
        // Unsubscribe from the provision response topic.
        // Will be resubscribed if another request is sent anyway
        (void)Provision_Unsubscribe();
    }
 
    bool Is_Response_Topic_Matching(char const * topic) const override {
        return strncmp(PROV_RESPONSE_TOPIC, topic, strlen(PROV_RESPONSE_TOPIC) + 1) == 0;
    }
 
    bool Unsubscribe() override {
        return Provision_Unsubscribe();
    }
 
    bool Resubscribe_Permanent_Subscriptions() override {
        m_provision_callback = Provision_Callback();
        return true;
    }
 
#if !THINGSBOARD_USE_ESP_TIMER
    void loop() override {
        auto & request_callback = m_provision_callback.Get_Request_Timeout();
        request_callback.Update_Timeout_Timer();
    }
#endif // !THINGSBOARD_USE_ESP_TIMER
 
    void Initialize() override {
        // Nothing to do
    }
 
    void Set_Client_Callbacks(Callback<void, IAPI_Implementation &>::function subscribe_api_callback, Callback<bool, char const * const, JsonDocument const &>::function send_json_callback, Callback<bool, char const * const, char const * const>::function send_json_string_callback, Callback<bool, char const * const>::function subscribe_topic_callback, Callback<bool, char const * const>::function unsubscribe_topic_callback, Callback<uint16_t>::function get_receive_size_callback, Callback<uint16_t>::function get_send_size_callback, Callback<bool, uint16_t, uint16_t>::function set_buffer_size_callback, Callback<size_t *>::function get_request_id_callback) override {
        m_send_json_callback.Set_Callback(send_json_callback);
    }
 
private:
    bool Provision_Subscribe(Provision_Callback const & callback) {
        m_provision_callback = callback;
        return true;
    }
 
    bool Provision_Unsubscribe() {
        return Resubscribe_Permanent_Subscriptions();
    }
 
    Callback<bool, char const * const, JsonDocument const &> m_send_json_callback = {};         // Send json document callback
 
    Provision_Callback                                       m_provision_callback = {};         // Provision response callback
};
 
#endif // Provision_h