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

Provides structure definition for SmartThings Things SDK. More...

#include <stdint.h>
#include <stdlib.h>
#include <stdbool.h>
Include dependency graph for st_things_types.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  _st_things_representation
 Structure for Representation. More...
 
struct  _st_things_get_request_message
 Structure for representing the Get Request Message. More...
 
struct  _st_things_set_request_message
 Structure for representing the Set Request Message. More...
 
enum  st_things_error_e {
  ST_THINGS_ERROR_NONE = 0, ST_THINGS_ERROR_INVALID_PARAMETER = -1, ST_THINGS_ERROR_OPERATION_FAILED = -2, ST_THINGS_ERROR_STACK_NOT_INITIALIZED = -3,
  ST_THINGS_ERROR_STACK_ALREADY_INITIALIZED = -4, ST_THINGS_ERROR_STACK_NOT_STARTED = -5, ST_THINGS_ERROR_STACK_RUNNING = -6
}
 Enumeration for ST Things error code. More...
 
enum  st_things_status_e {
  ST_THINGS_STATUS_INIT = 0, ST_THINGS_STATUS_ES_STARTED, ST_THINGS_STATUS_ES_DONE, ST_THINGS_STATUS_ES_FAILED_ON_OWNERSHIP_TRANSFER,
  ST_THINGS_STATUS_CONNECTING_TO_AP, ST_THINGS_STATUS_CONNECTED_TO_AP, ST_THINGS_STATUS_CONNECTING_TO_AP_FAILED, ST_THINGS_STATUS_REGISTERING_TO_CLOUD,
  ST_THINGS_STATUS_REGISTERED_TO_CLOUD, ST_THINGS_STATUS_REGISTERING_FAILED_ON_SIGN_IN, ST_THINGS_STATUS_REGISTERING_FAILED_ON_PUB_RES
}
 Enumeration for ST Things status. More...
 
typedef struct _st_things_representation st_things_representation_s
 Structure for Representation. More...
 
typedef struct _st_things_get_request_message st_things_get_request_message_s
 Structure for representing the Get Request Message. More...
 
typedef struct _st_things_set_request_message st_things_set_request_message_s
 Structure for representing the Set Request Message. More...
 

Detailed Description

Provides structure definition for SmartThings Things SDK.

Definition in file st_things_types.h.

Typedef Documentation

◆ st_things_get_request_message_s

Structure for representing the Get Request Message.

Since
Tizen RT v1.1

◆ st_things_representation_s

Structure for Representation.

Since
Tizen RT v1.1

◆ st_things_set_request_message_s

Structure for representing the Set Request Message.

Since
Tizen RT v1.1

Enumeration Type Documentation

◆ st_things_error_e

Enumeration for ST Things error code.

Since
Tizen RT v1.1
Enumerator
ST_THINGS_ERROR_NONE 

Successful

ST_THINGS_ERROR_INVALID_PARAMETER 

Invalid parameter (If parameter is null or empty)

ST_THINGS_ERROR_OPERATION_FAILED 

Operation Failed

ST_THINGS_ERROR_STACK_NOT_INITIALIZED 

Stack is not yet initialized

ST_THINGS_ERROR_STACK_ALREADY_INITIALIZED 

Stack is already initialized

ST_THINGS_ERROR_STACK_NOT_STARTED 

Stack is not yet started

ST_THINGS_ERROR_STACK_RUNNING 

Stack is currently running

Definition at line 38 of file st_things_types.h.

◆ st_things_status_e

Enumeration for ST Things status.

Since
Tizen RT v1.1
Enumerator
ST_THINGS_STATUS_INIT 

Initial state of ST Things

ST_THINGS_STATUS_ES_STARTED 

Easy-setup is started

ST_THINGS_STATUS_ES_DONE 

Easy-setup is done

ST_THINGS_STATUS_ES_FAILED_ON_OWNERSHIP_TRANSFER 

Easy-setup failed due to Ownership-Transfer failure

ST_THINGS_STATUS_CONNECTING_TO_AP 

Connecting to target Wi-Fi access point

ST_THINGS_STATUS_CONNECTED_TO_AP 

Connected to target Wi-Fi access point

ST_THINGS_STATUS_CONNECTING_TO_AP_FAILED 

Failed to connect to target Wi-Fi access point

ST_THINGS_STATUS_REGISTERING_TO_CLOUD 

Trying to Sign-up/Sign-in/Publish-Resource(s) to Cloud

ST_THINGS_STATUS_REGISTERED_TO_CLOUD 

Publish resource(s) to cloud is complete. Now the Thing is ready to be controlled via Cloud

ST_THINGS_STATUS_REGISTERING_FAILED_ON_SIGN_IN 

Failed to sign-in to Cloud

ST_THINGS_STATUS_REGISTERING_FAILED_ON_PUB_RES 

Failed to publish resources to Cloud

Definition at line 52 of file st_things_types.h.