Tizen RT Public API  v1.1 D4
st_things.h File Reference

Provides APIs for SmartThings Things SDK. More...

#include <stdint.h>
#include <stdbool.h>
#include "st_things_types.h"
Include dependency graph for st_things.h:

Go to the source code of this file.

Typedefs

typedef bool(* st_things_get_request_cb) (st_things_get_request_message_s *req_msg, st_things_representation_s *resp_rep)
 Callback for handling GET request. More...
 
typedef bool(* st_things_set_request_cb) (st_things_set_request_message_s *req_msg, st_things_representation_s *resp_rep)
 Callback for handling SET(POST) request. More...
 
typedef bool(* st_things_reset_confirm_cb) (void)
 Callback for getting user's opinion regarding device reset. More...
 
typedef void(* st_things_reset_result_cb) (bool is_success)
 Callback for carrying the result of reset. More...
 
typedef void(* st_things_pin_generated_cb) (const char *pin_data, const size_t pin_size)
 Callback for carrying the randomly generated PIN info. More...
 
typedef void(* st_things_pin_display_close_cb) (void)
 Callback for informing the application to close the PIN display. More...
 
typedef bool(* st_things_user_confirm_cb) (void)
 Callback for getting user's input regarding mutual verification. More...
 
typedef void(* st_things_status_change_cb) (st_things_status_e things_status)
 Callback for getting the current state of ST Things. More...
 

Functions

int st_things_initialize (const char *json_path, bool *easysetup_complete)
 Initializes things stack and returns whether easy-setup is completed or not. Easy-setup enable users to acquire the ownership of things and to connect the things with the cloud. After performing easy-setup, users can access things from anywhere through the cloud. In things stack, easy-setup is a primary and the first operation to be performed on the thing. Application running on the thing can know whether easy-setup is done already or not. If easy-setup is done, app can start the things stack by calling st_things_start(). If easy-setup is not done, app can either wait for the user interaction before starting the things stack or start the things stack directly without waiting for any events(This case is for those things which doesn't support input capability and for all other unknown cases). To use a new json file after initialization, stack should be deinitialized and stopped(if its started already). More...
 
int st_things_register_request_cb (st_things_get_request_cb get_cb, st_things_set_request_cb set_cb)
 Callback registration function for handling request messages. More...
 
int st_things_start (void)
 Starts things stack. Parses the thing definition(whose path is passed to st_things_initialize(), configures the thing, creates the resources and prepares it for easy-setup. If easy-setup is not done yet, onboarding will be started using either SoftAP or BLE connection. Onboarding creates an ad-hoc network between the thing and the client for performing easy-setup. If easy-setup is already done, thing will be connected with the cloud. Application can know whether easy-setup is done or not through st_things_initialize API. Stack should have been initialized before calling this API. More...
 
int st_things_register_reset_cb (st_things_reset_confirm_cb confirm_cb, st_things_reset_result_cb result_cb)
 Callback registration function for Reset-Confirmation and Reset-Result functions. More...
 
int st_things_reset (void)
 Reset all the data related to security and cloud being used in the stack. Stack should have been initialized and started before calling this API. More...
 
int st_things_register_user_confirm_cb (st_things_user_confirm_cb confirm_cb)
 Callback registration function for getting user confirmation for MUTUAL VERIFICATION BASED JUST WORK Ownership transfer. More...
 
int st_things_register_things_status_change_cb (st_things_status_change_cb status_cb)
 Callback registration function for getting notified when ST Things state changes. More...
 
int st_things_notify_observers (const char *resource_uri)
 Notify the observers of a specific resource. Stack should have been initialized and started before calling this API. More...
 
st_things_representation_sst_things_create_representation_inst (void)
 Create an instance of representation. More...
 
void st_things_destroy_representation_inst (st_things_representation_s *rep)
 Destroy an instance of representation. More...
 

Detailed Description

Provides APIs for SmartThings Things SDK.

Definition in file st_things.h.