st_thing_master_api/inc/smartthings.h

/*****************************************************************
 *
 * Copyright (c) 2018 Samsung Electronics Co., Ltd. All Rights Reserved
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 ******************************************************************/


#ifndef __SAMSUNG_EXPERIENCE_SERVICE_SMARTTHINGS_H__
#define __SAMSUNG_EXPERIENCE_SERVICE_SMARTTHINGS_H__

#include <stdlib.h>
#include <stdbool.h>
#include <tizen.h>

#ifdef __cplusplus
extern "C" {
#endif

#define SMARTTHINGS_SSID_LEN_MAX 32

#define SMARTTHINGS_CLOUD_INFO_LEN_MAX 128

typedef enum {
    SMARTTHINGS_ERROR_NONE = TIZEN_ERROR_NONE,                                
    SMARTTHINGS_ERROR_INVALID_PARAMETER = TIZEN_ERROR_INVALID_PARAMETER,      
    SMARTTHINGS_ERROR_OUT_OF_MEMORY = TIZEN_ERROR_OUT_OF_MEMORY,              
    SMARTTHINGS_ERROR_PERMISSION_DENIED = TIZEN_ERROR_PERMISSION_DENIED,      
    SMARTTHINGS_ERROR_NO_DATA = TIZEN_ERROR_NO_DATA,                          
    SMARTTHINGS_ERROR_NOT_SUPPORTED = TIZEN_ERROR_NOT_SUPPORTED,              
    SMARTTHINGS_ERROR_OPERATION_FAILED = TIZEN_ERROR_UNKNOWN - 1,             
    SMARTTHINGS_ERROR_SERVICE_UNAVAILABLE = TIZEN_ERROR_UNKNOWN -2            
} smartthings_error_e;

typedef enum {
    SMARTTHINGS_STATUS_NOT_READY = -1,                   
    SMARTTHINGS_STATUS_INIT = 0,                         
    SMARTTHINGS_STATUS_ES_STARTED,                       
    SMARTTHINGS_STATUS_ES_DONE,                          
    SMARTTHINGS_STATUS_ES_FAILED_ON_OWNERSHIP_TRANSFER,  
    SMARTTHINGS_STATUS_CONNECTING_TO_AP,                 
    SMARTTHINGS_STATUS_CONNECTED_TO_AP,                  
    SMARTTHINGS_STATUS_CONNECTING_TO_AP_FAILED,          
    SMARTTHINGS_STATUS_REGISTERING_TO_CLOUD,             
    SMARTTHINGS_STATUS_REGISTERED_TO_CLOUD,              
    SMARTTHINGS_STATUS_REGISTERING_FAILED_ON_SIGN_IN,    
    SMARTTHINGS_STATUS_REGISTERING_FAILED_ON_PUB_RES     
} smartthings_status_e;

typedef enum {
    SMARTTHINGS_CONNECTION_STATUS_CONNECTED = 0,            
    SMARTTHINGS_CONNECTION_STATUS_DISCONNECTED,             
    SMARTTHINGS_CONNECTION_STATUS_REJECTED,                 
} smartthings_connection_status_e;

typedef enum {
    SMARTTHINGS_WIFI_MODE_11A = (1 << 0),   
    SMARTTHINGS_WIFI_MODE_11B = (1 << 1),   
    SMARTTHINGS_WIFI_MODE_11G = (1 << 2),   
    SMARTTHINGS_WIFI_MODE_11N = (1 << 3),   
    SMARTTHINGS_WIFI_MODE_11AC = (1 << 4)   
} smartthings_wifi_mode_e;

typedef enum {
    SMARTTHINGS_WIFI_FREQ_24G = (1 << 0),       
    SMARTTHINGS_WIFI_FREQ_5G = (1 << 1),        
} smartthings_wifi_freq_e;

typedef enum {
    SMARTTHINGS_WIFI_AUTHTYPE_NONE = 0, 
    SMARTTHINGS_WIFI_AUTHTYPE_WEP,      
    SMARTTHINGS_WIFI_AUTHTYPE_WPA_PSK,  
    SMARTTHINGS_WIFI_AUTHTYPE_WPA2_PSK  
} smartthings_wifi_authtype_e;

typedef enum {
    SMARTTHINGS_WIFI_ENCTYPE_NONE = 0,      
    SMARTTHINGS_WIFI_ENCTYPE_WEP_64,        
    SMARTTHINGS_WIFI_ENCTYPE_WEP_128,       
    SMARTTHINGS_WIFI_ENCTYPE_TKIP,          
    SMARTTHINGS_WIFI_ENCTYPE_AES,           
    SMARTTHINGS_WIFI_ENCTYPE_TKIP_AES       
} smartthings_wifi_enctype_e;

typedef struct smartthings_s *smartthings_h;

typedef struct smartthings_ap_info_s *smartthings_ap_info_h;

typedef struct smartthings_device_prov_info_s *smartthings_device_prov_info_h;

typedef struct smartthings_cloud_info_s *smartthings_cloud_info_h;

typedef struct smartthings_ap_list_s *smartthings_ap_list_h;

typedef void (*smartthings_connection_status_cb)(smartthings_h handle, smartthings_connection_status_e status, void *user_data);

typedef void (*smartthings_status_changed_cb)(smartthings_h handle, smartthings_status_e status, void *user_data);

typedef void (*smartthings_user_confirm_cb)(smartthings_h handle, void *user_data);

typedef void (*smartthings_reset_confirm_cb)(smartthings_h handle, void *user_data);

typedef void (*smartthings_reset_result_cb)(smartthings_h handle, bool result, void *user_data);

typedef void (*smartthings_pin_generated_cb)(smartthings_h handle, const char* pin, size_t size, void *user_data);

typedef void (*smartthings_pin_display_close_cb)(smartthings_h handle, void *user_data);

typedef void (*smartthings_wifi_ap_provisioning_cb)(smartthings_h handle, smartthings_ap_info_h ap_info_h, void *user_data);

typedef void (*smartthings_device_provisioning_cb)(smartthings_h handle, smartthings_device_prov_info_h dev_prov_h, void *user_data);

typedef void (*smartthings_scan_ap_cb)(smartthings_h handle, int req_id, void *user_data);

typedef void (*smartthings_stop_soft_ap_cb)(smartthings_h handle, void *user_data);

int smartthings_initialize(smartthings_h *handle,
                        smartthings_connection_status_cb connection_status_cb,
                        void *user_data);

int smartthings_deinitialize(smartthings_h handle);

int smartthings_start(smartthings_h handle);

int smartthings_stop(smartthings_h handle);

int smartthings_set_status_changed_cb(smartthings_h handle,
                                smartthings_status_changed_cb status_cb,
                                void *user_data);

int smartthings_unset_status_changed_cb(smartthings_h handle);

int smartthings_set_certificate_file(smartthings_h handle, const char *certificate, const char *private_key);

int smartthings_set_device_property(smartthings_h handle, const char* dev_name, int wifi_mode, int wifi_freq);

int smartthings_get_device_id(smartthings_h handle, char **device_id);

int smartthings_get_easysetup_status(smartthings_h handle, bool *is_completed);

int smartthings_start_easysetup(smartthings_h handle);

int smartthings_stop_easysetup(smartthings_h handle);

int smartthings_set_user_confirm_cb(smartthings_h handle,
                                smartthings_user_confirm_cb confirm_cb,
                                void *user_data);

int smartthings_unset_user_confirm_cb(smartthings_h handle);

int smartthings_set_reset_confirm_cb(smartthings_h handle,
                                smartthings_reset_confirm_cb confirm_cb,
                                void *user_data);

int smartthings_unset_reset_confirm_cb(smartthings_h handle);

int smartthings_set_reset_result_cb(smartthings_h handle,
                                smartthings_reset_result_cb reset_result_cb,
                                void *user_data);

int smartthings_unset_reset_result_cb(smartthings_h handle);


int smartthings_set_pin_cb(smartthings_h handle,
                                smartthings_pin_generated_cb generated_cb,
                                smartthings_pin_display_close_cb close_cb,
                                void *user_data);

int smartthings_unset_pin_cb(smartthings_h handle);

int smartthings_set_wifi_ap_provisioning_cb(smartthings_h handle,
                                smartthings_wifi_ap_provisioning_cb wifi_ap_cb,
                                void *user_data);

int smartthings_unset_wifi_ap_provisioning_cb(smartthings_h handle);

int smartthings_set_device_provisioning_cb(smartthings_h handle,
                                smartthings_device_provisioning_cb dev_prov_cb,
                                void *user_data);

int smartthings_unset_device_provisioning_cb(smartthings_h handle);

int smartthings_set_scan_ap_cb(smartthings_h handle,
                                smartthings_scan_ap_cb scan_ap_cb,
                                void *user_data);

int smartthings_unset_scan_ap_cb(smartthings_h handle);

int smartthings_set_stop_soft_ap_cb(smartthings_h handle,
                                smartthings_stop_soft_ap_cb stop_soft_ap_cb,
                                void *user_data);

int smartthings_unset_stop_soft_ap_cb(smartthings_h handle);

int smartthings_send_user_confirm(smartthings_h handle, bool confirm);


int smartthings_send_reset_confirm(smartthings_h handle, bool confirm);

int smartthings_reset(smartthings_h handle);

int smartthings_apinfo_get_ssid(smartthings_ap_info_h ap_info_h, char **ssid);

int smartthings_apinfo_get_password(smartthings_ap_info_h ap_info_h, char **pwd);

int smartthings_apinfo_get_authtype(smartthings_ap_info_h ap_info_h, smartthings_wifi_authtype_e *authtype);

int smartthings_apinfo_get_enctype(smartthings_ap_info_h ap_info_h, smartthings_wifi_enctype_e *enctype);

int smartthings_apinfo_get_channel(smartthings_ap_info_h ap_info_h, int *channel);

int smartthings_devinfo_get_language(smartthings_device_prov_info_h dev_prov_h, char **language);

int smartthings_devinfo_get_country(smartthings_device_prov_info_h dev_prov_h, char **country);

int smartthings_devinfo_get_datetime(smartthings_device_prov_info_h dev_prov_h, char **datetime);

int smartthings_aplist_create(smartthings_ap_list_h *ap_list_h, unsigned int count);

int smartthings_aplist_destroy(smartthings_ap_list_h ap_list_h);

int smartthings_aplist_set_ssid(smartthings_ap_list_h ap_list_h, int idx, const char *ssid);

int smartthings_aplist_set_bssid(smartthings_ap_list_h ap_list_h, int idx, const char *bssid);

int smartthings_aplist_set_authtype(smartthings_ap_list_h ap_list_h, int idx, smartthings_wifi_authtype_e authtype);

int smartthings_aplist_set_enctype(smartthings_ap_list_h ap_list_h, int idx, smartthings_wifi_enctype_e enctype);

int smartthings_aplist_set_channel(smartthings_ap_list_h ap_list_h, int idx, int channel);

int smartthings_aplist_set_signal_level(smartthings_ap_list_h ap_list_h, int idx, int signal_level);

int smartthings_aplist_set_max_rate(smartthings_ap_list_h ap_list_h, int idx, int max_rate);

int smartthings_send_ap_list(smartthings_h handle, smartthings_ap_list_h ap_list_h, int req_id);

int smartthings_cloudinfo_create(smartthings_cloud_info_h *cloud_info_h);

int smartthings_cloudinfo_destroy(smartthings_cloud_info_h cloud_info_h);

int smartthings_cloudinfo_set_region(smartthings_cloud_info_h cloud_info_h, const char *region);

int smartthings_cloudinfo_set_auth_provider(smartthings_cloud_info_h cloud_info_h, const char *auth_provider);

int smartthings_cloudinfo_set_access_token(smartthings_cloud_info_h cloud_info_h, const char *access_token);

int smartthings_cloudinfo_set_refresh_token(smartthings_cloud_info_h cloud_info_h, const char *refresh_token);

int smartthings_cloudinfo_set_user_id(smartthings_cloud_info_h cloud_info_h, const char *user_id);

int smartthings_cloudinfo_set_client_id(smartthings_cloud_info_h cloud_info_h, const char *client_id);

int smartthings_sign_up_cloud(smartthings_h handle, smartthings_cloud_info_h cloud_info_h);

int smartthings_set_preconfigured_pin(smartthings_h handle, const char* pin);

int smartthings_set_mot_status(smartthings_h handle, bool enable);

#ifdef __cplusplus
}
#endif

#endif /* __SAMSUNG_EXPERIENCE_SERVICE_SMARTTHINGS_H__ */