1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
|
/*****************************************************************
*
* 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
/**
* @addtogroup CAPI_SMARTTHINGS_THING_MASTER_MODULE
* @{
*/
/**
* @brief Definition for the max length of SSID for access point.
* @since_ses 1
*/
#define SMARTTHINGS_SSID_LEN_MAX 32
/**
* @brief Definition for the max length of cloud information.
* @since_ses 1
*/
#define SMARTTHINGS_CLOUD_INFO_LEN_MAX 128
/**
* @brief Enumeration for the SmartThings error.
* @since_ses 1
*/
typedef enum {
SMARTTHINGS_ERROR_NONE = TIZEN_ERROR_NONE, /**< Successful */
SMARTTHINGS_ERROR_INVALID_PARAMETER = TIZEN_ERROR_INVALID_PARAMETER, /**< Invalid parameter */
SMARTTHINGS_ERROR_OUT_OF_MEMORY = TIZEN_ERROR_OUT_OF_MEMORY, /**< Out of memory */
SMARTTHINGS_ERROR_PERMISSION_DENIED = TIZEN_ERROR_PERMISSION_DENIED, /**< Permission denied */
SMARTTHINGS_ERROR_NO_DATA = TIZEN_ERROR_NO_DATA, /**< No data */
SMARTTHINGS_ERROR_NOT_SUPPORTED = TIZEN_ERROR_NOT_SUPPORTED, /**< Not supported */
SMARTTHINGS_ERROR_OPERATION_FAILED = TIZEN_ERROR_UNKNOWN - 1, /**< Operation failed */
SMARTTHINGS_ERROR_SERVICE_UNAVAILABLE = TIZEN_ERROR_UNKNOWN -2 /**< Service unavailable */
} smartthings_error_e;
/**
* @brief Enumeration for SmartThings status.
* @since_ses 1
*/
typedef enum {
SMARTTHINGS_STATUS_NOT_READY = -1, /**< Service agent is not ready */
SMARTTHINGS_STATUS_INIT = 0, /**< Initial state of SmartThings Thing */
SMARTTHINGS_STATUS_ES_STARTED, /**< Easy-setup is started */
SMARTTHINGS_STATUS_ES_DONE, /**< Easy-setup is done */
SMARTTHINGS_STATUS_ES_FAILED_ON_OWNERSHIP_TRANSFER, /**< Easy-setup failed due to Ownership-Transfer failure */
SMARTTHINGS_STATUS_CONNECTING_TO_AP, /**< Connecting to target Wi-Fi access point */
SMARTTHINGS_STATUS_CONNECTED_TO_AP, /**< Connected to target Wi-Fi access point */
SMARTTHINGS_STATUS_CONNECTING_TO_AP_FAILED, /**< Failed to connect to target Wi-Fi access point */
SMARTTHINGS_STATUS_REGISTERING_TO_CLOUD, /**< Trying to sign up, sign in and publish resources to cloud */
SMARTTHINGS_STATUS_REGISTERED_TO_CLOUD, /**< Publish resources to cloud is complete. Now the thing is ready to be controlled via cloud */
SMARTTHINGS_STATUS_REGISTERING_FAILED_ON_SIGN_IN, /**< Failed to sign in to cloud */
SMARTTHINGS_STATUS_REGISTERING_FAILED_ON_PUB_RES /**< Failed to publish resources to cloud */
} smartthings_status_e;
/**
* @brief Enumeration for RPC connection status.
* @since_ses 1
*/
typedef enum {
SMARTTHINGS_CONNECTION_STATUS_CONNECTED = 0, /**< Connection is connected */
SMARTTHINGS_CONNECTION_STATUS_DISCONNECTED, /**< Connection is disconnected */
SMARTTHINGS_CONNECTION_STATUS_REJECTED, /**< Connection is rejected */
} smartthings_connection_status_e;
/**
* @brief The Wi-Fi mode.
* @since_ses 1
*/
typedef enum {
SMARTTHINGS_WIFI_MODE_11A = (1 << 0), /**< Wi-Fi 11A */
SMARTTHINGS_WIFI_MODE_11B = (1 << 1), /**< Wi-Fi 11B */
SMARTTHINGS_WIFI_MODE_11G = (1 << 2), /**< Wi-Fi 11G */
SMARTTHINGS_WIFI_MODE_11N = (1 << 3), /**< Wi-Fi 11N */
SMARTTHINGS_WIFI_MODE_11AC = (1 << 4) /**< Wi-Fi 11AC */
} smartthings_wifi_mode_e;
/**
* @brief The Wi-Fi frequency band.
* @since_ses 1
*/
typedef enum {
SMARTTHINGS_WIFI_FREQ_24G = (1 << 0), /**< Wi-Fi 2.4GHz */
SMARTTHINGS_WIFI_FREQ_5G = (1 << 1), /**< Wi-Fi 5GHz */
} smartthings_wifi_freq_e;
/**
* @brief The Wi-Fi authentication type of access point.
* @since_ses 1
*/
typedef enum {
SMARTTHINGS_WIFI_AUTHTYPE_NONE = 0, /**< No authentication */
SMARTTHINGS_WIFI_AUTHTYPE_WEP, /**< WEP */
SMARTTHINGS_WIFI_AUTHTYPE_WPA_PSK, /**< WPA-PSK */
SMARTTHINGS_WIFI_AUTHTYPE_WPA2_PSK /**< WPA2-PSK */
} smartthings_wifi_authtype_e;
/**
* @brief The Wi-Fi encryption type of access point.
* @since_ses 1
*/
typedef enum {
SMARTTHINGS_WIFI_ENCTYPE_NONE = 0, /**< No encryption */
SMARTTHINGS_WIFI_ENCTYPE_WEP_64, /**< WEP 64 */
SMARTTHINGS_WIFI_ENCTYPE_WEP_128, /**< WEP 128 */
SMARTTHINGS_WIFI_ENCTYPE_TKIP, /**< TKIP */
SMARTTHINGS_WIFI_ENCTYPE_AES, /**< AES */
SMARTTHINGS_WIFI_ENCTYPE_TKIP_AES /**< TKIP/AES */
} smartthings_wifi_enctype_e;
/**
* @brief The SmartThings handle.
* @since_ses 1
*/
typedef struct smartthings_s *smartthings_h;
/**
* @brief The access point information handle.
* @since_ses 1
*/
typedef struct smartthings_ap_info_s *smartthings_ap_info_h;
/**
* @brief The device provisioning information handle.
* @since_ses 1
*/
typedef struct smartthings_device_prov_info_s *smartthings_device_prov_info_h;
/**
* @brief The cloud information handle for cloud sign-up.
* @since_ses 1
*/
typedef struct smartthings_cloud_info_s *smartthings_cloud_info_h;
/**
* @brief The access point list handle.
* @since_ses 1
*/
typedef struct smartthings_ap_list_s *smartthings_ap_list_h;
/**
* @brief Callback for status of connection to SmartThings Thing agent.
* @since_ses 1
*
* @remarks The @a handle should not be released.
* @remarks The @a handle is the same object for which the callback was set/added.
* @remarks The @a handle will be released when smartthings_deinitialize() is called.
* @remarks When callback is called, user can see connection status as #smartthings_connection_status_e enumeration value.
*
* @param[in] result The result of connection operation
* @param[in] handle The SmartThings handle
* @param[in] status The status of connection
* @param[in] user_data The user data passed from the callback registration function
*
* @see smartthings_initialize()
*/
typedef void (*smartthings_connection_status_cb)(smartthings_h handle, smartthings_connection_status_e status, void *user_data);
/**
* @brief Callback for SmartThings Thing status.
* @since_ses 1
*
* @remarks The @a handle should not be released.
* @remarks The @a handle is the same object for which the callback was set/added.
* @remarks The @a handle will be released when smartthings_deinitialize() is called.
* @remarks When callback is called, user can see SmartThings status as #smartthings_status_e enumeration value.
*
* @param[in] handle The SmartThings handle
* @param[in] status The status of SmartThings
* @param[in] user_data The user data passed from the callback registration function
*
* @see smartthings_set_status_changed_cb()
* @see smartthings_unset_status_changed_cb()
*/
typedef void (*smartthings_status_changed_cb)(smartthings_h handle, smartthings_status_e status, void *user_data);
/**
* @brief Callback for getting user's input regarding mutual verification.
* @since_ses 1
*
* @remarks The @a handle should not be released.
* @remarks The @a handle is the same object for which the callback was set/added.
* @remarks The @a handle will be released when smartthings_deinitialize() is called.
* @remarks When callback is called, user can send a confirmation for mutual verification as true or false.
*
* @param[in] handle The SmartThings handle
* @param[in] user_data The user data passed from the callback registration function
*
* @see smartthings_set_user_confirm_cb()
* @see smartthings_unset_user_confirm_cb()
*/
typedef void (*smartthings_user_confirm_cb)(smartthings_h handle, void *user_data);
/**
* @brief Callback for getting user's opinion regarding device reset.
* @since_ses 1
*
* @remarks The @a handle should not be released.
* @remarks The @a handle is the same object for which the callback was set/added.
* @remarks The @a handle will be released when smartthings_deinitialize() is called.
* @remarks When callback is called, user can sends a confirmation for reset as true or false.
*
* @param[in] handle The SmartThings handle
* @param[in] user_data The user data passed from the callback registration function
*
* @see smartthings_set_reset_confirm_cb()
* @see smartthings_unset_reset_confirm_cb()
*/
typedef void (*smartthings_reset_confirm_cb)(smartthings_h handle, void *user_data);
/**
* @brief Callback for result of reset operation.
* @since_ses 1
*
* @remarks The @a handle should not be released.
* @remarks The @a handle is the same object for which the callback was set/added.
* @remarks The @a handle will be released when smartthings_deinitialize() is called.
* @remarks When callback is called, user can check reset operation succeeds or fails.
*
* @param[in] handle The SmartThings handle
* @param[in] result The result of reset
* @param[in] user_data The user data passed from the callback registration function
*
* @see smartthings_set_reset_result_cb()
* @see smartthings_unset_reset_result_cb()
*/
typedef void (*smartthings_reset_result_cb)(smartthings_h handle, bool result, void *user_data);
/**
* @brief Callback for carrying the randomly generated PIN information.
* @since_ses 1
*
* @remarks The @a handle should not be released.
* @remarks The @a handle is the same object for which the callback was set/added.
* @remarks The @a handle will be released when smartthings_deinitialize() is called.
* @remarks The @a pin can be used only in the callback. To use outside, make a copy.
* @remarks When callback is called, user can see PIN value and length.
*
* @param[in] handle The SmartThings handle
* @param[in] pin The PIN data in string format
* @param[in] size The PIN length of @a pin
* @param[in] user_data The user data passed from the callback registration function
*
* @see smartthings_set_pin_cb()
* @see smartthings_unset_pin_cb()
*/
typedef void (*smartthings_pin_generated_cb)(smartthings_h handle, const char* pin, size_t size, void *user_data);
/**
* @brief Callback for informing the application to close the PIN display.
* @since_ses 1
*
* @remarks The @a handle should not be released.
* @remarks The @a handle is the same object for which the callback was set/added.
* @remarks The @a handle will be released when smartthings_deinitialize() is called.
* @remarks When callback is called, user can know PIN based ownership transfer is finished.
*
* @param[in] handle The SmartThings handle
* @param[in] user_data The user data passed from the callback registration function
*
* @see smartthings_set_pin_cb()
* @see smartthings_unset_pin_cb()
*/
typedef void (*smartthings_pin_display_close_cb)(smartthings_h handle, void *user_data);
/**
* @brief Callback for informing Wi-Fi AP information to connect.
* @since_ses 1
*
* @remarks The @a handle should not be released.
* @remarks The @a handle is the same object for which the callback was set/added.
* @remarks The @a handle will be released when smartthings_deinitialize() is called.
* @remarks The @a ap_info_h should not be released.
* @remarks The @a ap_info_h will be released when smartthings_unset_wifi_ap_provisioning_cb() is called.
* @remarks When callback is called, user can get Wi-Fi provisioning information.
*
* @param[in] handle The SmartThings handle
* @param[in] ap_info_h The AP information handle
* @param[in] user_data The user data passed from the callback registration function
*
* @see smartthings_set_wifi_ap_provisioning_cb()
* @see smartthings_unset_wifi_ap_provisioning_cb()
*/
typedef void (*smartthings_wifi_ap_provisioning_cb)(smartthings_h handle, smartthings_ap_info_h ap_info_h, void *user_data);
/**
* @brief Callback for informing device provisioning information.
* @since_ses 1
*
* @remarks The @a handle should not be released.
* @remarks The @a handle is the same object for which the callback was set/added.
* @remarks The @a handle will be released when smartthings_deinitialize() is called.
* @remarks The @a dev_prov_h should not be released.
* @remarks The @a dev_prov_h will be released when smartthings_unset_device_provisioning_cb() is called.
* @remarks When callback is called, user can get device provisioning information.
*
* @param[in] handle The SmartThings handle
* @param[in] dev_prov_h The device provisioning information handle
* @param[in] user_data The user data passed from the callback registration function
*
* @see smartthings_set_device_provisioning_cb()
* @see smartthings_unset_device_provisioning_cb()
*/
typedef void (*smartthings_device_provisioning_cb)(smartthings_h handle, smartthings_device_prov_info_h dev_prov_h, void *user_data);
/**
* @brief Callback for informing the scan AP list request.
* @since_ses 1
*
* @remarks The @a handle should not be released.
* @remarks The @a handle is the same object for which the callback was set/added.
* @remarks The @a handle will be released when smartthings_deinitialize() is called.
* @remarks When callback is called, user scans access points, sets AP list and sends it to agent.
*
* @param[in] handle The SmartThings handle
* @param[in] req_id The request ID
* @param[in] user_data The user data passed from the callback registration function
*
* @see smartthings_set_scan_ap_cb()
* @see smartthings_unset_scan_ap_cb()
*/
typedef void (*smartthings_scan_ap_cb)(smartthings_h handle, int req_id, void *user_data);
/**
* @brief Callback for informing the stop soft AP request.
* @since_ses 1
*
* @remarks The @a handle should not be released.
* @remarks The @a handle is the same object for which the callback was set/added.
* @remarks The @a handle will be released when smartthings_deinitialize() is called.
* @remarks When callback is called, user stops soft AP.
*
* @param[in] handle The SmartThings handle
* @param[in] user_data The user data passed from the callback registration function
*
* @see smartthings_set_stop_soft_ap_cb()
* @see smartthings_unset_stop_soft_ap_cb()
*/
typedef void (*smartthings_stop_soft_ap_cb)(smartthings_h handle, void *user_data);
/**
* @brief Creates a handle and connects to agent.
* @since_ses 1
* @privilege %http://com.samsung.tizen.smartthings-thing/appdefined/smartthings-thing.master \n
* %http://tizen.org/privilege/appmanager.launch \n
* %http://tizen.org/privilege/datasharing
*
* @remarks The @a handle must be released using smartthings_deinitialize().
* @remarks Ths function returns #SMARTTHINGS_ERROR_PERMISSION_DENIED\n
* if the application has no app-defined privilege for 'http://com.samsung.tizen.smartthings-thing/appdefined/smartthings-thing.master'.
*
* @param[out] handle The SmartThings handle to be newly created on success
* @param[in] connection_status_cb The RPC connection status callback to register
* @param[in] user_data The user data to be passed to the callback function
*
* @return @c 0 on success,
* otherwise a negative error value
* @retval #SMARTTHINGS_ERROR_NONE Successful
* @retval #SMARTTHINGS_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #SMARTTHINGS_ERROR_OUT_OF_MEMORY Out of memory
* @retval #SMARTTHINGS_ERROR_PERMISSION_DENIED Permission denied
* @retval #SMARTTHINGS_ERROR_OPERATION_FAILED Operation failed
* @retval #SMARTTHINGS_ERROR_NOT_SUPPORTED Not supported
* @retval #SMARTTHINGS_ERROR_SERVICE_UNAVAILABLE Service unavailable
*
* @see smartthings_deinitialize()
*/
int smartthings_initialize(smartthings_h *handle,
smartthings_connection_status_cb connection_status_cb,
void *user_data);
/**
* @brief Deinitializes a handle and disconnects from the agent.
* @since_ses 1
*
* @param[in] handle The SmartThings handle
*
* @return @c 0 on success,
* otherwise a negative error value
* @retval #SMARTTHINGS_ERROR_NONE Successful
* @retval #SMARTTHINGS_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #SMARTTHINGS_ERROR_OPERATION_FAILED Operation failed
*
* @see smartthings_initialize()
*/
int smartthings_deinitialize(smartthings_h handle);
/**
* @brief Starts SmartThings Thing operation.
* @since_ses 1
* @privilege %http://com.samsung.tizen.smartthings-thing/appdefined/smartthings-thing.master \n
* %http://tizen.org/privilege/appmanager.launch \n
* %http://tizen.org/privilege/datasharing
*
* @param[in] handle The SmartThings handle
*
* @return @c 0 on success,
* otherwise a negative error value
* @retval #SMARTTHINGS_ERROR_NONE Successful
* @retval #SMARTTHINGS_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #SMARTTHINGS_ERROR_PERMISSION_DENIED Permission denied
* @retval #SMARTTHINGS_ERROR_OPERATION_FAILED Operation failed
* @retval #SMARTTHINGS_ERROR_SERVICE_UNAVAILABLE Service unavailable
*
* @see smartthings_stop()
*/
int smartthings_start(smartthings_h handle);
/**
* @brief Stops SmartThings Thing operation.
* @since_ses 1
* @privilege %http://com.samsung.tizen.smartthings-thing/appdefined/smartthings-thing.master \n
* %http://tizen.org/privilege/appmanager.launch \n
* %http://tizen.org/privilege/datasharing
*
* @param[in] handle The SmartThings handle
*
* @return @c 0 on success,
* otherwise a negative error value
* @retval #SMARTTHINGS_ERROR_NONE Successful
* @retval #SMARTTHINGS_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #SMARTTHINGS_ERROR_PERMISSION_DENIED Permission denied
* @retval #SMARTTHINGS_ERROR_OPERATION_FAILED Operation failed
* @retval #SMARTTHINGS_ERROR_SERVICE_UNAVAILABLE Service unavailable
*
* @see smartthings_start()
*/
int smartthings_stop(smartthings_h handle);
/**
* @brief Sets thing status changed callback.
* @since_ses 1
* @privilege %http://com.samsung.tizen.smartthings-thing/appdefined/smartthings-thing.master \n
* %http://tizen.org/privilege/appmanager.launch \n
* %http://tizen.org/privilege/datasharing
*
* @remarks Only one callback function can be set with this function.
* @remarks If multiple callbacks are set, the last one is registered only.
* @remarks Callback is called when SmartThings status is changed.
* @remarks When callback is called, user can get SmartThings status as #smartthings_status_e enumeration value.
*
* @param[in] handle The SmartThings handle
* @param[in] status_cb The status changed callback to register
* @param[in] user_data The user data to be passed to the callback function
*
* @return @c 0 on success,
* otherwise a negative error value
* @retval #SMARTTHINGS_ERROR_NONE Successful
* @retval #SMARTTHINGS_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #SMARTTHINGS_ERROR_PERMISSION_DENIED Permission denied
* @retval #SMARTTHINGS_ERROR_OPERATION_FAILED Operation failed
* @retval #SMARTTHINGS_ERROR_SERVICE_UNAVAILABLE Service unavailable
*
* @see smartthings_unset_status_changed_cb()
*/
int smartthings_set_status_changed_cb(smartthings_h handle,
smartthings_status_changed_cb status_cb,
void *user_data);
/**
* @brief Unsets thing status changed callback.
* @since_ses 1
* @privilege %http://com.samsung.tizen.smartthings-thing/appdefined/smartthings-thing.master \n
* %http://tizen.org/privilege/appmanager.launch \n
* %http://tizen.org/privilege/datasharing
*
* @param[in] handle The SmartThings handle
*
* @return @c 0 on success,
* otherwise a negative error value
* @retval #SMARTTHINGS_ERROR_NONE Successful
* @retval #SMARTTHINGS_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #SMARTTHINGS_ERROR_PERMISSION_DENIED Permission denied
* @retval #SMARTTHINGS_ERROR_OPERATION_FAILED Operation failed
* @retval #SMARTTHINGS_ERROR_SERVICE_UNAVAILABLE Service unavailable
*
* @see smartthings_set_status_changed_cb()
*/
int smartthings_unset_status_changed_cb(smartthings_h handle);
/**
* @brief Sets test certificate files.
* @since_ses 1
* @privilege %http://com.samsung.tizen.smartthings-thing/appdefined/smartthings-thing.master \n
* %http://tizen.org/privilege/appmanager.launch \n
* %http://tizen.org/privilege/datasharing
*
* @remarks These files should be placed in 'res' directory of application.
* @remarks This function is needed only for using test certificate.
* @remarks This function can be used before smartthings_start()
*
* @param[in] handle The SmartThings handle
* @param[in] certificate The certificate file
* @param[in] private_key The private key file
*
* @return @c 0 on success,
* otherwise a negative error value
* @retval #SMARTTHINGS_ERROR_NONE Successful
* @retval #SMARTTHINGS_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #SMARTTHINGS_ERROR_PERMISSION_DENIED Permission denied
* @retval #SMARTTHINGS_ERROR_OPERATION_FAILED Operation failed
* @retval #SMARTTHINGS_ERROR_SERVICE_UNAVAILABLE Service unavailable
*/
int smartthings_set_certificate_file(smartthings_h handle, const char *certificate, const char *private_key);
/**
* @brief Sets device property for Easy-setup.
* @since_ses 1
*
* @remarks This function can be used before smartthings_start()
*
* @param[in] handle The SmartThings handle
* @param[in] dev_name The device name
* @param[in] wifi_mode The supported Wi-Fi mode (bit masked value for #smartthings_wifi_mode_e)
* @param[in] wifi_freq The supported Wi-Fi frequency (bit masked value for #smartthings_wifi_freq_e)
*
* @return @c 0 on success,
* otherwise a negative error value
* @retval #SMARTTHINGS_ERROR_NONE Successful
* @retval #SMARTTHINGS_ERROR_INVALID_PARAMETER Invalid parameter
*/
int smartthings_set_device_property(smartthings_h handle, const char* dev_name, int wifi_mode, int wifi_freq);
/**
* @brief Gets a device ID.
* @since_ses 1
* @privilege %http://com.samsung.tizen.smartthings-thing/appdefined/smartthings-thing.master \n
* %http://tizen.org/privilege/appmanager.launch \n
* %http://tizen.org/privilege/datasharing
*
* @remarks The @a device_id should be released using free().
*
* @param[in] handle The SmartThings handle
* @param[out] device_id The device ID
*
* @return @c 0 on success,
* otherwise a negative error value
* @retval #SMARTTHINGS_ERROR_NONE Successful
* @retval #SMARTTHINGS_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #SMARTTHINGS_ERROR_PERMISSION_DENIED Permission denied
* @retval #SMARTTHINGS_ERROR_OPERATION_FAILED Operation failed
* @retval #SMARTTHINGS_ERROR_SERVICE_UNAVAILABLE Service unavailable
*/
int smartthings_get_device_id(smartthings_h handle, char **device_id);
/**
* @brief Gets a Easy-setup status.
* @since_ses 1
* @privilege %http://com.samsung.tizen.smartthings-thing/appdefined/smartthings-thing.master \n
* %http://tizen.org/privilege/appmanager.launch \n
* %http://tizen.org/privilege/datasharing
*
* @param[in] handle The SmartThings handle
* @param[out] is_completed The status of Easy-setup whether it is completed or not
*
* @return @c 0 on success,
* otherwise a negative error value
* @retval #SMARTTHINGS_ERROR_NONE Successful
* @retval #SMARTTHINGS_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #SMARTTHINGS_ERROR_PERMISSION_DENIED Permission denied
* @retval #SMARTTHINGS_ERROR_OPERATION_FAILED Operation failed
* @retval #SMARTTHINGS_ERROR_SERVICE_UNAVAILABLE Service unavailable
*/
int smartthings_get_easysetup_status(smartthings_h handle, bool *is_completed);
/**
* @brief Starts Easy-setup mode.
*
* @details This function requests for turning on soft AP to SmartThings Thing agent.
* @since_ses 1
* @privilege %http://com.samsung.tizen.smartthings-thing/appdefined/smartthings-thing.master \n
* %http://tizen.org/privilege/appmanager.launch \n
* %http://tizen.org/privilege/datasharing \n
* %http://tizen.org/privilege/softap
*
* @param[in] handle The SmartThings handle
*
* @return @c 0 on success,
* otherwise a negative error value
* @retval #SMARTTHINGS_ERROR_NONE Successful
* @retval #SMARTTHINGS_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #SMARTTHINGS_ERROR_PERMISSION_DENIED Permission denied
* @retval #SMARTTHINGS_ERROR_OPERATION_FAILED Operation failed
* @retval #SMARTTHINGS_ERROR_SERVICE_UNAVAILABLE Service unavailable
*
* @see smartthings_stop_easysetup()
*/
int smartthings_start_easysetup(smartthings_h handle);
/**
* @brief Stops Easy-setup mode.
*
* @details This function requests for turning off soft AP to SmartThings Thing agent.
* @since_ses 1
* @privilege %http://com.samsung.tizen.smartthings-thing/appdefined/smartthings-thing.master \n
* %http://tizen.org/privilege/appmanager.launch \n
* %http://tizen.org/privilege/datasharing \n
* %http://tizen.org/privilege/softap
*
* @param[in] handle The SmartThings handle
*
* @return @c 0 on success,
* otherwise a negative error value
* @retval #SMARTTHINGS_ERROR_NONE Successful
* @retval #SMARTTHINGS_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #SMARTTHINGS_ERROR_PERMISSION_DENIED Permission denied
* @retval #SMARTTHINGS_ERROR_OPERATION_FAILED Operation failed
* @retval #SMARTTHINGS_ERROR_SERVICE_UNAVAILABLE Service unavailable
*
* @see smartthings_start_easysetup()
*/
int smartthings_stop_easysetup(smartthings_h handle);
/**
* @brief Sets callback for getting user confirmation for mutual verification based just work ownership transfer.
* @since_ses 1
* @privilege %http://com.samsung.tizen.smartthings-thing/appdefined/smartthings-thing.master \n
* %http://tizen.org/privilege/appmanager.launch \n
* %http://tizen.org/privilege/datasharing
*
* @remarks Only one callback function can be set with this function.
* @remarks If multiple callbacks are set, the last one is registered only.
* @remarks Callback is called when it needs user's confirm for mutual verification based just work ownership transfer.
* @remarks When callback is called, user can send a confirmation for mutual verification based just work ownership transfer as true or false.
*
* @param[in] handle The SmartThings handle
* @param[in] confirm_cb The user confirm callback to register
* @param[in] user_data The user data to be passed to the callback function
*
* @return @c 0 on success,
* otherwise a negative error value
* @retval #SMARTTHINGS_ERROR_NONE Successful
* @retval #SMARTTHINGS_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #SMARTTHINGS_ERROR_PERMISSION_DENIED Permission denied
* @retval #SMARTTHINGS_ERROR_OPERATION_FAILED Operation failed
* @retval #SMARTTHINGS_ERROR_SERVICE_UNAVAILABLE Service unavailable
*
* @see smartthings_unset_user_confirm_cb()
*/
int smartthings_set_user_confirm_cb(smartthings_h handle,
smartthings_user_confirm_cb confirm_cb,
void *user_data);
/**
* @brief Unsets user confirmation callback.
* @since_ses 1
* @privilege %http://com.samsung.tizen.smartthings-thing/appdefined/smartthings-thing.master \n
* %http://tizen.org/privilege/appmanager.launch \n
* %http://tizen.org/privilege/datasharing
*
* @param[in] handle The SmartThings handle
*
* @return @c 0 on success,
* otherwise a negative error value
* @retval #SMARTTHINGS_ERROR_NONE Successful
* @retval #SMARTTHINGS_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #SMARTTHINGS_ERROR_PERMISSION_DENIED Permission denied
* @retval #SMARTTHINGS_ERROR_OPERATION_FAILED Operation failed
* @retval #SMARTTHINGS_ERROR_SERVICE_UNAVAILABLE Service unavailable
*
* @see smartthings_set_user_confirm_cb()
*/
int smartthings_unset_user_confirm_cb(smartthings_h handle);
/**
* @brief Sets reset confirmation callback.
* @since_ses 1
* @privilege %http://com.samsung.tizen.smartthings-thing/appdefined/smartthings-thing.master \n
* %http://tizen.org/privilege/appmanager.launch \n
* %http://tizen.org/privilege/datasharing
*
* @remarks Only one callback function can be set with this function.
* @remarks If multiple callbacks are set, the last one is registered only.
* @remarks Callback is called when it needs user's confirm for reset.
* @remarks When callback is called, user can send a confirmation for reset as true or false.
*
* @param[in] handle The SmartThings handle
* @param[in] confirm_cb The reset confirm callback to register
* @param[in] user_data The user data to be passed to the callback function
*
* @return @c 0 on success,
* otherwise a negative error value
* @retval #SMARTTHINGS_ERROR_NONE Successful
* @retval #SMARTTHINGS_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #SMARTTHINGS_ERROR_PERMISSION_DENIED Permission denied
* @retval #SMARTTHINGS_ERROR_OPERATION_FAILED Operation failed
* @retval #SMARTTHINGS_ERROR_SERVICE_UNAVAILABLE Service unavailable
*
* @see smartthings_unset_reset_confirm_cb()
*/
int smartthings_set_reset_confirm_cb(smartthings_h handle,
smartthings_reset_confirm_cb confirm_cb,
void *user_data);
/**
* @brief Unsets reset confirmation callback.
* @since_ses 1
* @privilege %http://com.samsung.tizen.smartthings-thing/appdefined/smartthings-thing.master \n
* %http://tizen.org/privilege/appmanager.launch \n
* %http://tizen.org/privilege/datasharing
*
* @param[in] handle The SmartThings handle
*
* @return @c 0 on success,
* otherwise a negative error value
* @retval #SMARTTHINGS_ERROR_NONE Successful
* @retval #SMARTTHINGS_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #SMARTTHINGS_ERROR_PERMISSION_DENIED Permission denied
* @retval #SMARTTHINGS_ERROR_OPERATION_FAILED Operation failed
* @retval #SMARTTHINGS_ERROR_SERVICE_UNAVAILABLE Service unavailable
*
* @see smartthings_set_reset_confirm_cb()
*/
int smartthings_unset_reset_confirm_cb(smartthings_h handle);
/**
* @brief Sets reset result callback.
* @since_ses 1
* @privilege %http://com.samsung.tizen.smartthings-thing/appdefined/smartthings-thing.master \n
* %http://tizen.org/privilege/appmanager.launch \n
* %http://tizen.org/privilege/datasharing
*
* @remarks Only one callback function can be set with this function.
* @remarks If multiple callbacks are set, the last one is registered only.
* @remarks Callback is called when reset operation returns its result.
* @remarks When callback is called, user can check reset operation succeeds or fails.
*
* @param[in] handle The SmartThings handle
* @param[in] reset_result_cb The reset result callback to register
* @param[in] user_data The user data to be passed to the callback function
*
* @return @c 0 on success,
* otherwise a negative error value
* @retval #SMARTTHINGS_ERROR_NONE Successful
* @retval #SMARTTHINGS_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #SMARTTHINGS_ERROR_PERMISSION_DENIED Permission denied
* @retval #SMARTTHINGS_ERROR_OPERATION_FAILED Operation failed
* @retval #SMARTTHINGS_ERROR_SERVICE_UNAVAILABLE Service unavailable
*
* @see smartthings_unset_reset_result_cb()
*/
int smartthings_set_reset_result_cb(smartthings_h handle,
smartthings_reset_result_cb reset_result_cb,
void *user_data);
/**
* @brief Unsets reset result callback.
* @since_ses 1
* @privilege %http://com.samsung.tizen.smartthings-thing/appdefined/smartthings-thing.master \n
* %http://tizen.org/privilege/appmanager.launch \n
* %http://tizen.org/privilege/datasharing
*
* @param[in] handle The SmartThings handle
*
* @return @c 0 on success,
* otherwise a negative error value
* @retval #SMARTTHINGS_ERROR_NONE Successful
* @retval #SMARTTHINGS_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #SMARTTHINGS_ERROR_PERMISSION_DENIED Permission denied
* @retval #SMARTTHINGS_ERROR_OPERATION_FAILED Operation failed
* @retval #SMARTTHINGS_ERROR_SERVICE_UNAVAILABLE Service unavailable
*
* @see smartthings_set_reset_result_cb()
*/
int smartthings_unset_reset_result_cb(smartthings_h handle);
/**
* @brief Sets callback for getting randomly generated PIN for the PIN-based ownership transfer request.
* @since_ses 1
* @privilege %http://com.samsung.tizen.smartthings-thing/appdefined/smartthings-thing.master \n
* %http://tizen.org/privilege/appmanager.launch \n
* %http://tizen.org/privilege/datasharing
*
* @remarks Only one callback function can be set with this function.
* @remarks If multiple callbacks are set, the last one is registered only.
* @remarks @a generated_cb callback is called when PIN is generated.
* @remarks @a close_cb callback is called when PIN based ownership transfer is finished.
* @remarks When @a generated_cb callback is called, user can see PIN value and length.
* @remarks When @a close_cb callback is called, user can know PIN based ownership transfer is finished.
*
* @param[in] handle The SmartThings handle
* @param[in] generated_cb The PIN generation callback to register
* @param[in] close_cb The PIN display close callback to register
* @param[in] user_data The user data to be passed to the callback function
*
* @return @c 0 on success,
* otherwise a negative error value
* @retval #SMARTTHINGS_ERROR_NONE Successful
* @retval #SMARTTHINGS_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #SMARTTHINGS_ERROR_PERMISSION_DENIED Permission denied
* @retval #SMARTTHINGS_ERROR_OPERATION_FAILED Operation failed
* @retval #SMARTTHINGS_ERROR_SERVICE_UNAVAILABLE Service unavailable
*
* @see smartthings_unset_pin_cb()
*/
int smartthings_set_pin_cb(smartthings_h handle,
smartthings_pin_generated_cb generated_cb,
smartthings_pin_display_close_cb close_cb,
void *user_data);
/**
* @brief Unsets PIN callback.
* @since_ses 1
* @privilege %http://com.samsung.tizen.smartthings-thing/appdefined/smartthings-thing.master \n
* %http://tizen.org/privilege/appmanager.launch \n
* %http://tizen.org/privilege/datasharing
*
* @param[in] handle The SmartThings handle
*
* @return @c 0 on success,
* otherwise a negative error value
* @retval #SMARTTHINGS_ERROR_NONE Successful
* @retval #SMARTTHINGS_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #SMARTTHINGS_ERROR_PERMISSION_DENIED Permission denied
* @retval #SMARTTHINGS_ERROR_OPERATION_FAILED Operation failed
* @retval #SMARTTHINGS_ERROR_SERVICE_UNAVAILABLE Service unavailable
*
* @see smartthings_set_pin_cb()
*/
int smartthings_unset_pin_cb(smartthings_h handle);
/**
* @brief Sets callback for getting Wi-Fi AP information during Easy-setup.
* @since_ses 1
* @privilege %http://com.samsung.tizen.smartthings-thing/appdefined/smartthings-thing.master \n
* %http://tizen.org/privilege/appmanager.launch \n
* %http://tizen.org/privilege/datasharing
*
* @remarks Only one callback function can be set with this function.
* @remarks If multiple callbacks are set, the last one is registered only.
* @remarks Callback is called when Wi-Fi provisioning event occurs.
* @remarks When callback is called, user can get Wi-Fi provisioning information.
*
* @param[in] handle The SmartThings handle
* @param[in] wifi_ap_cb The Wi-Fi AP callback to register
* @param[in] user_data The user data to be passed to the callback function
*
* @return @c 0 on success,
* otherwise a negative error value
* @retval #SMARTTHINGS_ERROR_NONE Successful
* @retval #SMARTTHINGS_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #SMARTTHINGS_ERROR_PERMISSION_DENIED Permission denied
* @retval #SMARTTHINGS_ERROR_OPERATION_FAILED Operation failed
* @retval #SMARTTHINGS_ERROR_SERVICE_UNAVAILABLE Service unavailable
*
* @see smartthings_unset_wifi_ap_provisioning_cb()
*/
int smartthings_set_wifi_ap_provisioning_cb(smartthings_h handle,
smartthings_wifi_ap_provisioning_cb wifi_ap_cb,
void *user_data);
/**
* @brief Unsets callback for getting Wi-Fi AP information during Easy-setup.
* @since_ses 1
* @privilege %http://com.samsung.tizen.smartthings-thing/appdefined/smartthings-thing.master \n
* %http://tizen.org/privilege/appmanager.launch \n
* %http://tizen.org/privilege/datasharing
*
* @param[in] handle The SmartThings handle
*
* @return @c 0 on success,
* otherwise a negative error value
* @retval #SMARTTHINGS_ERROR_NONE Successful
* @retval #SMARTTHINGS_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #SMARTTHINGS_ERROR_PERMISSION_DENIED Permission denied
* @retval #SMARTTHINGS_ERROR_OPERATION_FAILED Operation failed
* @retval #SMARTTHINGS_ERROR_SERVICE_UNAVAILABLE Service unavailable
*
* @see smartthings_set_wifi_ap_provisioning_cb()
*/
int smartthings_unset_wifi_ap_provisioning_cb(smartthings_h handle);
/**
* @brief Sets callback for getting device provisioning information.
* @since_ses 1
* @privilege %http://com.samsung.tizen.smartthings-thing/appdefined/smartthings-thing.master \n
* %http://tizen.org/privilege/appmanager.launch \n
* %http://tizen.org/privilege/datasharing
*
* @remarks Only one callback function can be set with this function.
* @remarks If multiple callbacks are set, the last one is registered only.
* @remarks Callback is called when device provisioning event occurs.
* @remarks When callback is called, user can get device provisioning information.
*
* @param[in] handle The SmartThings handle
* @param[in] dev_prov_cb The device provisioning callback to register
* @param[in] user_data The user data to be passed to the callback function
*
* @return @c 0 on success,
* otherwise a negative error value
* @retval #SMARTTHINGS_ERROR_NONE Successful
* @retval #SMARTTHINGS_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #SMARTTHINGS_ERROR_PERMISSION_DENIED Permission denied
* @retval #SMARTTHINGS_ERROR_OPERATION_FAILED Operation failed
* @retval #SMARTTHINGS_ERROR_SERVICE_UNAVAILABLE Service unavailable
*
* @see smartthings_unset_device_provisioning_cb()
*/
int smartthings_set_device_provisioning_cb(smartthings_h handle,
smartthings_device_provisioning_cb dev_prov_cb,
void *user_data);
/**
* @brief Unsets callback for getting device provisioning information.
* @since_ses 1
* @privilege %http://com.samsung.tizen.smartthings-thing/appdefined/smartthings-thing.master \n
* %http://tizen.org/privilege/appmanager.launch \n
* %http://tizen.org/privilege/datasharing
*
* @param[in] handle The SmartThings handle
*
* @return @c 0 on success,
* otherwise a negative error value
* @retval #SMARTTHINGS_ERROR_NONE Successful
* @retval #SMARTTHINGS_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #SMARTTHINGS_ERROR_PERMISSION_DENIED Permission denied
* @retval #SMARTTHINGS_ERROR_OPERATION_FAILED Operation failed
* @retval #SMARTTHINGS_ERROR_SERVICE_UNAVAILABLE Service unavailable
*
* @see smartthings_set_device_provisioning_cb()
*/
int smartthings_unset_device_provisioning_cb(smartthings_h handle);
/**
* @brief Sets callback for informing the scan AP list request.
* @since_ses 1
* @privilege %http://com.samsung.tizen.smartthings-thing/appdefined/smartthings-thing.master \n
* %http://tizen.org/privilege/appmanager.launch \n
* %http://tizen.org/privilege/datasharing
*
* @remarks Only one callback function can be set with this function.
* @remarks If multiple callbacks are set, the last one is registered only.
* @remarks Callback is called when GET request for access point list.
* @remarks When callback is called, user scans access points, sets AP list and sends it to agent.
*
* @param[in] handle The SmartThings handle
* @param[in] scan_ap_cb The callback to register
* @param[in] user_data The user data to be passed to the callback function
*
* @return @c 0 on success,
* otherwise a negative error value
* @retval #SMARTTHINGS_ERROR_NONE Successful
* @retval #SMARTTHINGS_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #SMARTTHINGS_ERROR_PERMISSION_DENIED Permission denied
* @retval #SMARTTHINGS_ERROR_OPERATION_FAILED Operation failed
* @retval #SMARTTHINGS_ERROR_SERVICE_UNAVAILABLE Service unavailable
*
* @see smartthings_unset_scan_ap_cb()
* @see smartthings_send_ap_list()
*/
int smartthings_set_scan_ap_cb(smartthings_h handle,
smartthings_scan_ap_cb scan_ap_cb,
void *user_data);
/**
* @brief Unsets callback for informing the scan AP list request.
* @since_ses 1
* @privilege %http://com.samsung.tizen.smartthings-thing/appdefined/smartthings-thing.master \n
* %http://tizen.org/privilege/appmanager.launch \n
* %http://tizen.org/privilege/datasharing
*
* @param[in] handle The SmartThings handle
*
* @return @c 0 on success,
* otherwise a negative error value
* @retval #SMARTTHINGS_ERROR_NONE Successful
* @retval #SMARTTHINGS_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #SMARTTHINGS_ERROR_PERMISSION_DENIED Permission denied
* @retval #SMARTTHINGS_ERROR_OPERATION_FAILED Operation failed
* @retval #SMARTTHINGS_ERROR_SERVICE_UNAVAILABLE Service unavailable
*
* @see smartthings_set_scan_ap_cb()
*/
int smartthings_unset_scan_ap_cb(smartthings_h handle);
/**
* @brief Sets callback for informing the stop soft AP request.
* @since_ses 1
* @privilege %http://com.samsung.tizen.smartthings-thing/appdefined/smartthings-thing.master \n
* %http://tizen.org/privilege/appmanager.launch \n
* %http://tizen.org/privilege/datasharing
*
* @remarks Only one callback function can be set with this function.
* @remarks If multiple callbacks are set, the last one is registered only.
* @remarks Callback is called when POST request for stopping soft AP.
* @remarks When callback is called, user stops soft AP.
*
* @param[in] handle The SmartThings handle
* @param[in] stop_soft_ap_cb The callback to register
* @param[in] user_data The user data to be passed to the callback function
*
* @return @c 0 on success,
* otherwise a negative error value
* @retval #SMARTTHINGS_ERROR_NONE Successful
* @retval #SMARTTHINGS_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #SMARTTHINGS_ERROR_PERMISSION_DENIED Permission denied
* @retval #SMARTTHINGS_ERROR_OPERATION_FAILED Operation failed
* @retval #SMARTTHINGS_ERROR_SERVICE_UNAVAILABLE Service unavailable
*
* @see smartthings_unset_stop_soft_ap_cb()
*/
int smartthings_set_stop_soft_ap_cb(smartthings_h handle,
smartthings_stop_soft_ap_cb stop_soft_ap_cb,
void *user_data);
/**
* @brief Unsets callback for informing the stop soft AP request.
* @since_ses 1
* @privilege %http://com.samsung.tizen.smartthings-thing/appdefined/smartthings-thing.master \n
* %http://tizen.org/privilege/appmanager.launch \n
* %http://tizen.org/privilege/datasharing
*
* @param[in] handle The SmartThings handle
*
* @return @c 0 on success,
* otherwise a negative error value
* @retval #SMARTTHINGS_ERROR_NONE Successful
* @retval #SMARTTHINGS_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #SMARTTHINGS_ERROR_PERMISSION_DENIED Permission denied
* @retval #SMARTTHINGS_ERROR_OPERATION_FAILED Operation failed
* @retval #SMARTTHINGS_ERROR_SERVICE_UNAVAILABLE Service unavailable
*
* @see smartthings_set_stop_soft_ap_cb()
*/
int smartthings_unset_stop_soft_ap_cb(smartthings_h handle);
/**
* @brief Sends a user confirmation for MUTUAL VERIFICATION BASED JUST WORK Ownership transfer.
* @since_ses 1
* @privilege %http://com.samsung.tizen.smartthings-thing/appdefined/smartthings-thing.master \n
* %http://tizen.org/privilege/appmanager.launch \n
* %http://tizen.org/privilege/datasharing \n
* %http://tizen.org/privilege/internet
*
* @param[in] handle The SmartThings handle
* @param[in] confirm The user confirmation for OTM(ownership transfer method)
*
* @return @c 0 on success,
* otherwise a negative error value
* @retval #SMARTTHINGS_ERROR_NONE Successful
* @retval #SMARTTHINGS_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #SMARTTHINGS_ERROR_PERMISSION_DENIED Permission denied
* @retval #SMARTTHINGS_ERROR_OPERATION_FAILED Operation failed
* @retval #SMARTTHINGS_ERROR_SERVICE_UNAVAILABLE Service unavailable
*
* @see smartthings_set_user_confirm_cb()
* @see smartthings_unset_user_confirm_cb()
*/
int smartthings_send_user_confirm(smartthings_h handle, bool confirm);
/**
* @brief Sends a reset confirmation.
* @since_ses 1
* @privilege %http://com.samsung.tizen.smartthings-thing/appdefined/smartthings-thing.master \n
* %http://tizen.org/privilege/appmanager.launch \n
* %http://tizen.org/privilege/datasharing \n
* %http://tizen.org/privilege/internet
*
* @param[in] handle The SmartThings handle
* @param[in] confirm The reset confirmation
*
* @return @c 0 on success,
* otherwise a negative error value
* @retval #SMARTTHINGS_ERROR_NONE Successful
* @retval #SMARTTHINGS_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #SMARTTHINGS_ERROR_PERMISSION_DENIED Permission denied
* @retval #SMARTTHINGS_ERROR_OPERATION_FAILED Operation failed
* @retval #SMARTTHINGS_ERROR_SERVICE_UNAVAILABLE Service unavailable
*
* @see smartthings_set_reset_confirm_cb()
* @see smartthings_unset_reset_confirm_cb()
*/
int smartthings_send_reset_confirm(smartthings_h handle, bool confirm);
/**
* @brief Sends a reset command for resetting the device's Cloud signup and Easy-setup.
* @since_ses 1
* @privilege %http://com.samsung.tizen.smartthings-thing/appdefined/smartthings-thing.master \n
* %http://tizen.org/privilege/appmanager.launch \n
* %http://tizen.org/privilege/datasharing \n
* %http://tizen.org/privilege/internet
*
* @param[in] handle The SmartThings handle
*
* @return @c 0 on success,
* otherwise a negative error value
* @retval #SMARTTHINGS_ERROR_NONE Successful
* @retval #SMARTTHINGS_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #SMARTTHINGS_ERROR_PERMISSION_DENIED Permission denied
* @retval #SMARTTHINGS_ERROR_OPERATION_FAILED Operation failed
* @retval #SMARTTHINGS_ERROR_SERVICE_UNAVAILABLE Service unavailable
*
* @see smartthings_set_reset_result_cb()
* @see smartthings_unset_reset_result_cb()
*/
int smartthings_reset(smartthings_h handle);
/**
* @brief Gets SSID of access point.
* @since_ses 1
*
* @remarks The @a ssid should be released using free().
*
* @param[in] ap_info_h The SmartThings AP information handle
* @param[out] ssid The SSID name
*
* @return @c 0 on success,
* otherwise a negative error value
* @retval #SMARTTHINGS_ERROR_NONE Successful
* @retval #SMARTTHINGS_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #SMARTTHINGS_ERROR_OPERATION_FAILED Operation failed
*
* @see smartthings_set_wifi_ap_provisioning_cb()
* @see smartthings_unset_wifi_ap_provisioning_cb()
*/
int smartthings_apinfo_get_ssid(smartthings_ap_info_h ap_info_h, char **ssid);
/**
* @brief Gets password of access point.
* @since_ses 1
*
* @remarks The @a pwd should be released using free().
*
* @param[in] ap_info_h The SmartThings AP information handle
* @param[out] pwd The password
*
* @return @c 0 on success,
* otherwise a negative error value
* @retval #SMARTTHINGS_ERROR_NONE Successful
* @retval #SMARTTHINGS_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #SMARTTHINGS_ERROR_OPERATION_FAILED Operation failed
*
* @see smartthings_set_wifi_ap_provisioning_cb()
* @see smartthings_unset_wifi_ap_provisioning_cb()
*/
int smartthings_apinfo_get_password(smartthings_ap_info_h ap_info_h, char **pwd);
/**
* @brief Gets authentification type of access point.
* @since_ses 1
*
* @param[in] ap_info_h The SmartThings AP information handle
* @param[out] authtype The authentification type
*
* @return @c 0 on success,
* otherwise a negative error value
* @retval #SMARTTHINGS_ERROR_NONE Successful
* @retval #SMARTTHINGS_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #SMARTTHINGS_ERROR_OPERATION_FAILED Operation failed
*
* @see smartthings_set_wifi_ap_provisioning_cb()
* @see smartthings_unset_wifi_ap_provisioning_cb()
*/
int smartthings_apinfo_get_authtype(smartthings_ap_info_h ap_info_h, smartthings_wifi_authtype_e *authtype);
/**
* @brief Gets encryption type of access point.
* @since_ses 1
*
* @param[in] ap_info_h The SmartThings AP information handle
* @param[out] enctype The encryption type
*
* @return @c 0 on success,
* otherwise a negative error value
* @retval #SMARTTHINGS_ERROR_NONE Successful
* @retval #SMARTTHINGS_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #SMARTTHINGS_ERROR_OPERATION_FAILED Operation failed
*
* @see smartthings_set_wifi_ap_provisioning_cb()
* @see smartthings_unset_wifi_ap_provisioning_cb()
*/
int smartthings_apinfo_get_enctype(smartthings_ap_info_h ap_info_h, smartthings_wifi_enctype_e *enctype);
/**
* @brief Gets channel information of access point.
* @since_ses 1
*
* @param[in] ap_info_h The SmartThings AP information handle
* @param[out] channel The frequency channel
*
* @return @c 0 on success,
* otherwise a negative error value
* @retval #SMARTTHINGS_ERROR_NONE Successful
* @retval #SMARTTHINGS_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #SMARTTHINGS_ERROR_OPERATION_FAILED Operation failed
*
* @see smartthings_set_wifi_ap_provisioning_cb()
* @see smartthings_unset_wifi_ap_provisioning_cb()
*/
int smartthings_apinfo_get_channel(smartthings_ap_info_h ap_info_h, int *channel);
/**
* @brief Gets language of device provisioing information.
* @since_ses 1
*
* @remarks The @a language should be released using free().
*
* @param[in] dev_prov_h The SmartThings device provisioning information handle
* @param[out] language The IETF language tag using ISO 639X
*
* @return @c 0 on success,
* otherwise a negative error value
* @retval #SMARTTHINGS_ERROR_NONE Successful
* @retval #SMARTTHINGS_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #SMARTTHINGS_ERROR_OPERATION_FAILED Operation failed
*
* @see smartthings_set_device_provisioning_cb()
* @see smartthings_unset_device_provisioning_cb()
*/
int smartthings_devinfo_get_language(smartthings_device_prov_info_h dev_prov_h, char **language);
/**
* @brief Gets country of device provisioing information.
* @since_ses 1
*
* @remarks The @a country should be released using free().
*
* @param[in] dev_prov_h The SmartThings device provisioning information handle
* @param[out] country The ISO Country Code (ISO 3166-1 Alpha-2)
*
* @return @c 0 on success,
* otherwise a negative error value
* @retval #SMARTTHINGS_ERROR_NONE Successful
* @retval #SMARTTHINGS_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #SMARTTHINGS_ERROR_OPERATION_FAILED Operation failed
*
* @see smartthings_set_device_provisioning_cb()
* @see smartthings_unset_device_provisioning_cb()
*/
int smartthings_devinfo_get_country(smartthings_device_prov_info_h dev_prov_h, char **country);
/**
* @brief Gets datetime of device provisioing information.
* @since_ses 1
*
* @remarks The @a datetime should be released using free().
*
* @param[in] dev_prov_h The SmartThings device provisioning information handle
* @param[out] datetime The date and time
*
* @return @c 0 on success,
* otherwise a negative error value
* @retval #SMARTTHINGS_ERROR_NONE Successful
* @retval #SMARTTHINGS_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #SMARTTHINGS_ERROR_OPERATION_FAILED Operation failed
*
* @see smartthings_set_device_provisioning_cb()
* @see smartthings_unset_device_provisioning_cb()
*/
int smartthings_devinfo_get_datetime(smartthings_device_prov_info_h dev_prov_h, char **datetime);
/**
* @brief Creates a SmartThings AP list handle.
* @since_ses 1
*
* @remarks The @a ap_list_h must be released using smartthings_aplist_destroy().
*
* @param[out] ap_list_h The SmartThings AP list handle to be newly created on success
* @param[in] count The count of AP
*
* @return @c 0 on success,
* otherwise a negative error value
* @retval #SMARTTHINGS_ERROR_NONE Successful
* @retval #SMARTTHINGS_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #SMARTTHINGS_ERROR_OUT_OF_MEMORY Out of memory
*
* @see smartthings_aplist_destroy()
*/
int smartthings_aplist_create(smartthings_ap_list_h *ap_list_h, unsigned int count);
/**
* @brief Destroys a SmartThings AP list handle.
* @since_ses 1
*
* @param[in] ap_list_h The SmartThings AP list handle
*
* @return @c 0 on success,
* otherwise a negative error value
* @retval #SMARTTHINGS_ERROR_NONE Successful
* @retval #SMARTTHINGS_ERROR_INVALID_PARAMETER Invalid parameter
*
* @see smartthings_aplist_create()
*/
int smartthings_aplist_destroy(smartthings_ap_list_h ap_list_h);
/**
* @brief Sets SSID at the specific index of AP list handle.
* @since_ses 1
*
* @param[in] ap_list_h The SmartThings AP list handle
* @param[in] idx The index
* @param[in] ssid The SSID of AP
*
* @return @c 0 on success,
* otherwise a negative error value
* @retval #SMARTTHINGS_ERROR_NONE Successful
* @retval #SMARTTHINGS_ERROR_INVALID_PARAMETER Invalid parameter
*
* @see smartthings_aplist_create()
* @see smartthings_aplist_destroy()
*/
int smartthings_aplist_set_ssid(smartthings_ap_list_h ap_list_h, int idx, const char *ssid);
/**
* @brief Sets BSSID at the specific index of AP list handle.
* @since_ses 1
*
* @param[in] ap_list_h The SmartThings AP list handle
* @param[in] idx The index
* @param[in] bssid The BSSID of AP
*
* @return @c 0 on success,
* otherwise a negative error value
* @retval #SMARTTHINGS_ERROR_NONE Successful
* @retval #SMARTTHINGS_ERROR_INVALID_PARAMETER Invalid parameter
*
* @see smartthings_aplist_create()
* @see smartthings_aplist_destroy()
*/
int smartthings_aplist_set_bssid(smartthings_ap_list_h ap_list_h, int idx, const char *bssid);
/**
* @brief Sets authentification type at the specific index of AP list handle.
* @since_ses 1
*
* @param[in] ap_list_h The SmartThings AP list handle
* @param[in] idx The index
* @param[in] authtype The authentification type of AP
*
* @return @c 0 on success,
* otherwise a negative error value
* @retval #SMARTTHINGS_ERROR_NONE Successful
* @retval #SMARTTHINGS_ERROR_INVALID_PARAMETER Invalid parameter
*
* @see smartthings_aplist_create()
* @see smartthings_aplist_destroy()
*/
int smartthings_aplist_set_authtype(smartthings_ap_list_h ap_list_h, int idx, smartthings_wifi_authtype_e authtype);
/**
* @brief Sets encryption type at the specific index of AP list handle.
* @since_ses 1
*
* @param[in] ap_list_h The SmartThings AP list handle
* @param[in] idx The index
* @param[in] enctype The encryption type of AP
*
* @return @c 0 on success,
* otherwise a negative error value
* @retval #SMARTTHINGS_ERROR_NONE Successful
* @retval #SMARTTHINGS_ERROR_INVALID_PARAMETER Invalid parameter
*
* @see smartthings_aplist_create()
* @see smartthings_aplist_destroy()
*/
int smartthings_aplist_set_enctype(smartthings_ap_list_h ap_list_h, int idx, smartthings_wifi_enctype_e enctype);
/**
* @brief Sets frequency channel at the specific index of AP list handle.
* @since_ses 1
*
* @param[in] ap_list_h The SmartThings AP list handle
* @param[in] idx The index
* @param[in] channel The frequency channel of AP
*
* @return @c 0 on success,
* otherwise a negative error value
* @retval #SMARTTHINGS_ERROR_NONE Successful
* @retval #SMARTTHINGS_ERROR_INVALID_PARAMETER Invalid parameter
*
* @see smartthings_aplist_create()
* @see smartthings_aplist_destroy()
*/
int smartthings_aplist_set_channel(smartthings_ap_list_h ap_list_h, int idx, int channel);
/**
* @brief Sets signal level at the specific index of AP list handle.
* @since_ses 1
*
* @param[in] ap_list_h The SmartThings AP list handle
* @param[in] idx The index
* @param[in] signal_level The signal level of AP
*
* @return @c 0 on success,
* otherwise a negative error value
* @retval #SMARTTHINGS_ERROR_NONE Successful
* @retval #SMARTTHINGS_ERROR_INVALID_PARAMETER Invalid parameter
*
* @see smartthings_aplist_create()
* @see smartthings_aplist_destroy()
*/
int smartthings_aplist_set_signal_level(smartthings_ap_list_h ap_list_h, int idx, int signal_level);
/**
* @brief Sets max speed rate at the specific index of AP list handle.
* @since_ses 1
*
* @param[in] ap_list_h The SmartThings AP list handle
* @param[in] idx The index
* @param[in] max_rate The max speed rate of AP
*
* @return @c 0 on success,
* otherwise a negative error value
* @retval #SMARTTHINGS_ERROR_NONE Successful
* @retval #SMARTTHINGS_ERROR_INVALID_PARAMETER Invalid parameter
*
* @see smartthings_aplist_create()
* @see smartthings_aplist_destroy()
*/
int smartthings_aplist_set_max_rate(smartthings_ap_list_h ap_list_h, int idx, int max_rate);
/**
* @brief Sends the scanned AP list.
* @since_ses 1
* @privilege %http://com.samsung.tizen.smartthings-thing/appdefined/smartthings-thing.master \n
* %http://tizen.org/privilege/appmanager.launch \n
* %http://tizen.org/privilege/datasharing \n
* %http://tizen.org/privilege/internet
*
* @param[in] handle The SmartThings handle
* @param[in] ap_list_h The SmartThings AP list handle
* @param[in] req_id The request ID
*
* @return @c 0 on success,
* otherwise a negative error value
* @retval #SMARTTHINGS_ERROR_NONE Successful
* @retval #SMARTTHINGS_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #SMARTTHINGS_ERROR_OUT_OF_MEMORY Out of memory
* @retval #SMARTTHINGS_ERROR_PERMISSION_DENIED Permission denied
* @retval #SMARTTHINGS_ERROR_OPERATION_FAILED Operation failed
* @retval #SMARTTHINGS_ERROR_SERVICE_UNAVAILABLE Service unavailable
*
* @see smartthings_aplist_create()
* @see smartthings_aplist_destroy()
* @see smartthings_set_scan_ap_cb()
*/
int smartthings_send_ap_list(smartthings_h handle, smartthings_ap_list_h ap_list_h, int req_id);
/**
* @brief Creates a SmartThings cloud information handle.
* @since_ses 1
*
* @remarks The @a cloud_info_h must be released using smartthings_cloudinfo_destroy().
*
* @param[out] cloud_info_h The SmartThings cloud information handle to be newly created on success
*
* @return @c 0 on success,
* otherwise a negative error value
* @retval #SMARTTHINGS_ERROR_NONE Successful
* @retval #SMARTTHINGS_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #SMARTTHINGS_ERROR_OUT_OF_MEMORY Out of memory
*
* @see smartthings_cloudinfo_destroy()
*/
int smartthings_cloudinfo_create(smartthings_cloud_info_h *cloud_info_h);
/**
* @brief Destroys a SmartThings cloud information handle.
* @since_ses 1
*
* @param[in] cloud_info_h The SmartThings cloud information handle
*
* @return @c 0 on success,
* otherwise a negative error value
* @retval #SMARTTHINGS_ERROR_NONE Successful
* @retval #SMARTTHINGS_ERROR_INVALID_PARAMETER Invalid parameter
*
* @see smartthings_cloudinfo_create()
*/
int smartthings_cloudinfo_destroy(smartthings_cloud_info_h cloud_info_h);
/**
* @brief Sets region of cloud information.
* @since_ses 1
*
* @remarks The @a region can be set to one of "global" or "china".
* @remarks If it doesn't use this function, the @a region will be set to "global" internally.
*
* @param[in] cloud_info_h The SmartThings cloud information handle
* @param[in] region The region name
*
* @return @c 0 on success,
* otherwise a negative error value
* @retval #SMARTTHINGS_ERROR_NONE Successful
* @retval #SMARTTHINGS_ERROR_INVALID_PARAMETER Invalid parameter
*/
int smartthings_cloudinfo_set_region(smartthings_cloud_info_h cloud_info_h, const char *region);
/**
* @brief Sets authentification provider of cloud information.
* @since_ses 1
*
* @param[in] cloud_info_h The SmartThings cloud information handle
* @param[in] auth_provider The authentification provider
*
* @return @c 0 on success,
* otherwise a negative error value
* @retval #SMARTTHINGS_ERROR_NONE Successful
* @retval #SMARTTHINGS_ERROR_INVALID_PARAMETER Invalid parameter
*/
int smartthings_cloudinfo_set_auth_provider(smartthings_cloud_info_h cloud_info_h, const char *auth_provider);
/**
* @brief Sets access token of cloud information.
* @since_ses 1
*
* @param[in] cloud_info_h The SmartThings cloud information handle
* @param[in] access_token The access token
*
* @return @c 0 on success,
* otherwise a negative error value
* @retval #SMARTTHINGS_ERROR_NONE Successful
* @retval #SMARTTHINGS_ERROR_INVALID_PARAMETER Invalid parameter
*/
int smartthings_cloudinfo_set_access_token(smartthings_cloud_info_h cloud_info_h, const char *access_token);
/**
* @brief Sets refresh token of cloud information.
* @since_ses 1
*
* @param[in] cloud_info_h The SmartThings cloud information handle
* @param[in] refresh_token The refresh token
*
* @return @c 0 on success,
* otherwise a negative error value
* @retval #SMARTTHINGS_ERROR_NONE Successful
* @retval #SMARTTHINGS_ERROR_INVALID_PARAMETER Invalid parameter
*/
int smartthings_cloudinfo_set_refresh_token(smartthings_cloud_info_h cloud_info_h, const char *refresh_token);
/**
* @brief Sets user ID of cloud information.
* @since_ses 1
*
* @param[in] cloud_info_h The SmartThings cloud information handle
* @param[in] user_id The user ID
*
* @return @c 0 on success,
* otherwise a negative error value
* @retval #SMARTTHINGS_ERROR_NONE Successful
* @retval #SMARTTHINGS_ERROR_INVALID_PARAMETER Invalid parameter
*/
int smartthings_cloudinfo_set_user_id(smartthings_cloud_info_h cloud_info_h, const char *user_id);
/**
* @brief Sets client ID of cloud information.
* @since_ses 1
*
* @param[in] cloud_info_h The SmartThings cloud information handle
* @param[in] client_id The client ID
*
* @return @c 0 on success,
* otherwise a negative error value
* @retval #SMARTTHINGS_ERROR_NONE Successful
* @retval #SMARTTHINGS_ERROR_INVALID_PARAMETER Invalid parameter
*/
int smartthings_cloudinfo_set_client_id(smartthings_cloud_info_h cloud_info_h, const char *client_id);
/**
* @brief Requests to sign up to cloud.
* @since_ses 1
* @privilege %http://com.samsung.tizen.smartthings-thing/appdefined/smartthings-thing.master \n
* %http://tizen.org/privilege/appmanager.launch \n
* %http://tizen.org/privilege/datasharing \n
* %http://tizen.org/privilege/internet
*
* @param[in] handle The SmartThings handle
* @param[in] cloud_info_h The handle for cloud signup
*
* @return @c 0 on success,
* otherwise a negative error value
* @retval #SMARTTHINGS_ERROR_NONE Successful
* @retval #SMARTTHINGS_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #SMARTTHINGS_ERROR_PERMISSION_DENIED Permission denied
* @retval #SMARTTHINGS_ERROR_OPERATION_FAILED Operation failed
* @retval #SMARTTHINGS_ERROR_SERVICE_UNAVAILABLE Service unavailable
*/
int smartthings_sign_up_cloud(smartthings_h handle, smartthings_cloud_info_h cloud_info_h);
/**
* @brief Sets preconfigured PIN.
* @since_ses 1
* @privilege %http://com.samsung.tizen.smartthings-thing/appdefined/smartthings-thing.master \n
* %http://tizen.org/privilege/appmanager.launch \n
* %http://tizen.org/privilege/datasharing
*
* @param[in] handle The SmartThings handle
* @param[in] pin The PIN code to preconfigure
*
* @return @c 0 on success,
* otherwise a negative error value
* @retval #SMARTTHINGS_ERROR_NONE Successful
* @retval #SMARTTHINGS_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #SMARTTHINGS_ERROR_PERMISSION_DENIED Permission denied
* @retval #SMARTTHINGS_ERROR_OPERATION_FAILED Operation failed
* @retval #SMARTTHINGS_ERROR_SERVICE_UNAVAILABLE Service unavailable
*/
int smartthings_set_preconfigured_pin(smartthings_h handle, const char* pin);
/**
* @brief Sets MOT(multiple ownership transfer) status.
* @since_ses 1
* @privilege %http://com.samsung.tizen.smartthings-thing/appdefined/smartthings-thing.master \n
* %http://tizen.org/privilege/appmanager.launch \n
* %http://tizen.org/privilege/datasharing
*
* @param[in] handle The SmartThings handle
* @param[in] enable The MOT(multiple ownership transfer) status
*
* @return @c 0 on success,
* otherwise a negative error value
* @retval #SMARTTHINGS_ERROR_NONE Successful
* @retval #SMARTTHINGS_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #SMARTTHINGS_ERROR_PERMISSION_DENIED Permission denied
* @retval #SMARTTHINGS_ERROR_OPERATION_FAILED Operation failed
* @retval #SMARTTHINGS_ERROR_SERVICE_UNAVAILABLE Service unavailable
*/
int smartthings_set_mot_status(smartthings_h handle, bool enable);
/**
* @}
*/
#ifdef __cplusplus
}
#endif
#endif /* __SAMSUNG_EXPERIENCE_SERVICE_SMARTTHINGS_H__ */
|