kii_thing_if.h

Go to the documentation of this file.

#ifndef _KII_THING_IF_
#define _KII_THING_IF_

#include <kii.h>

#define EMESSAGE_SIZE 50

#ifdef __cplusplus
extern "C" {
#endif

#define KII_THING_IF_TASK_NAME_STATUS_UPDATE "status_update_task"

typedef enum kii_thing_if_state_t {
    KII_THING_IF_STATE_INITIALIZED,
    KII_THING_IF_STATE_ONBOARDED,
    KII_THING_IF_STATE_STARTED
} kii_thing_if_state_t;

typedef enum kii_thing_if_error_code_t {
    KII_THING_IF_ERROR_INVALID_STATE,

    KII_THING_IF_ERROR_HTTP,

    KII_THING_IF_ERROR_SOCKET,

    KII_THING_IF_ERROR_INSUFFICIENT_BUFFER,

    KII_THING_IF_ERROR_INSUFFICIENT_ARG_BUFFER,

    KII_THING_IF_ERROR_INVALID_PAYLOAD
} kii_thing_if_error_code_t;

typedef struct kii_thing_if_error_t {
    kii_thing_if_error_code_t code;

    int http_status_code;

    char error_code[64];
} kii_thing_if_error_t;

typedef kii_bool_t
    (*KII_THING_IF_ACTION_HANDLER)
        (const char* alias,
         const char* action_name,
         const char* action_params,
         char error[EMESSAGE_SIZE + 1]);

typedef kii_bool_t (*KII_THING_IF_WRITER)(kii_t* kii, const char* buff);

typedef kii_bool_t
    (*KII_THING_IF_STATE_HANDLER)
        (kii_t* kii,
         KII_THING_IF_WRITER writer);

typedef kii_bool_t
    (*KII_THING_IF_CUSTOM_PUSH_HANDLER)
        (kii_t *kii,
         const char* message,
         size_t message_length);

typedef struct kii_thing_if_command_handler_resource_t {
    char* buffer;

    size_t buffer_size;

    char* mqtt_buffer;

    size_t mqtt_buffer_size;

    KII_THING_IF_ACTION_HANDLER action_handler;

    KII_THING_IF_STATE_HANDLER state_handler;

    KII_THING_IF_CUSTOM_PUSH_HANDLER custom_push_handler;

} kii_thing_if_command_handler_resource_t;

typedef struct kii_thing_if_state_updater_resource_t {
    char* buffer;

    size_t buffer_size;

    int period;

    KII_THING_IF_STATE_HANDLER state_handler;
} kii_thing_if_state_updater_resource_t;

typedef struct kii_thing_if_system_cb_t {
    KII_TASK_CREATE       task_create_cb;
    KII_DELAY_MS          delay_ms_cb;
    KII_LOGGER            log_cb;
    KII_SOCKET_CONNECT_CB socket_connect_cb;
    KII_SOCKET_SEND_CB    socket_send_cb;
    KII_SOCKET_RECV_CB    socket_recv_cb;
    KII_SOCKET_CLOSE_CB   socket_close_cb;
    KII_SOCKET_CONNECT_CB mqtt_socket_connect_cb;
    KII_SOCKET_SEND_CB    mqtt_socket_send_cb;
    KII_SOCKET_RECV_CB    mqtt_socket_recv_cb;
    KII_SOCKET_CLOSE_CB   mqtt_socket_close_cb;
} kii_thing_if_system_cb_t;

typedef struct kii_thing_if_t {
    kii_t command_handler;
    kii_t state_updater;
    KII_THING_IF_ACTION_HANDLER action_handler;
    KII_THING_IF_STATE_HANDLER state_handler_for_period;
    KII_THING_IF_STATE_HANDLER state_handler_for_command_reaction;
    KII_THING_IF_CUSTOM_PUSH_HANDLER custom_push_handler;
    int state_update_period;
    kii_thing_if_state_t state;
} kii_thing_if_t;

kii_bool_t init_kii_thing_if(
        kii_thing_if_t* kii_thing_if,
        const char* app_id,
        const char* app_key,
        const char* app_host,
        kii_thing_if_command_handler_resource_t* command_handler_resource,
        kii_thing_if_state_updater_resource_t* state_updater_resource,
        kii_thing_if_system_cb_t* system_cb,
        KII_JSON_RESOURCE_CB resource_cb);

kii_bool_t start(kii_thing_if_t* kii_thing_if);

kii_bool_t onboard_with_vendor_thing_id(
        kii_thing_if_t* kii_thing_if,
        const char* vendor_thing_id,
        const char* password,
        const char* thing_type,
        const char* firmware_version,
        const char* layout_position,
        const char* thing_properties,
        kii_thing_if_error_t* error);

kii_bool_t onboard_with_thing_id(
        kii_thing_if_t* kii_thing_if,
        const char* thing_id,
        const char* password,
        const char* thing_type,
        const char* firmware_version,
        const char* layout_position,
        const char* thing_properties,
        kii_thing_if_error_t* error);


kii_bool_t init_kii_thing_if_with_onboarded_thing(
        kii_thing_if_t* kii_thing_if,
        const char* app_id,
        const char* app_key,
        const char* app_host,
        const char* thing_id,
        const char* access_token,
        kii_thing_if_command_handler_resource_t* command_handler_resource,
        kii_thing_if_state_updater_resource_t* state_updater_resource,
        kii_thing_if_system_cb_t* system_cb,
        KII_JSON_RESOURCE_CB resource_cb);

kii_bool_t update_firmware_version(
        kii_thing_if_t* kii_thing_if,
        const char* firmware_version,
        kii_thing_if_error_t* error);

kii_bool_t get_firmware_version(
        kii_thing_if_t* kii_thing_if,
        char* firmware_version,
        size_t firmware_version_len,
        kii_thing_if_error_t* error);

kii_bool_t update_thing_type(
        kii_thing_if_t* kii_thing_if,
        const char* thing_type,
        kii_thing_if_error_t* error);

kii_bool_t get_thing_type(
        kii_thing_if_t* kii_thing_if,
        char* thing_type,
        size_t thing_type_len,
        kii_thing_if_error_t* error);

#ifdef __cplusplus
}
#endif

#endif /* _KII_THING_IF_ */