1 //******************************************************************
3 // Copyright 2015 Samsung Electronics All Rights Reserved.
5 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
7 // Licensed under the Apache License, Version 2.0 (the "License");
8 // you may not use this file except in compliance with the License.
9 // You may obtain a copy of the License at
11 // http://www.apache.org/licenses/LICENSE-2.0
13 // Unless required by applicable law or agreed to in writing, software
14 // distributed under the License is distributed on an "AS IS" BASIS,
15 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 // See the License for the specific language governing permissions and
17 // limitations under the License.
19 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
33 #define OIC_STRING_MAX_VALUE 100
34 #define IPV4_ADDR_SIZE 16
38 * @brief Mac address length for BT port
40 #define NET_MACADDR_SIZE 18
43 * Attributes used to form a proper easysetup conforming JSON message.
45 #define OC_RSRVD_ES_PROVSTATUS "ps"
46 #define OC_RSRVD_ES_LAST_ERRORCODE "lec"
47 #define OC_RSRVD_ES_LINKS "links"
48 #define OC_RSRVD_ES_SUPPORTEDWIFIMODE "swmt"
49 #define OC_RSRVD_ES_SUPPORTEDWIFIFREQ "swf"
50 #define OC_RSRVD_ES_SSID "tnn"
51 #define OC_RSRVD_ES_CRED "cd"
52 #define OC_RSRVD_ES_AUTHTYPE "wat"
53 #define OC_RSRVD_ES_ENCTYPE "wet"
54 #define OC_RSRVD_ES_AUTHCODE "ac"
55 #define OC_RSRVD_ES_AUTHPROVIDER "apn"
56 #define OC_RSRVD_ES_CISERVER "cis"
57 #define OC_RSRVD_ES_SERVERID "sid"
58 #define OC_RSRVD_ES_DEVNAME "dn"
59 #define OC_RSRVD_ES_LANGUAGE "lang"
60 #define OC_RSRVD_ES_COUNTRY "ctry"
63 * Easysetup defined resoruce types and uris.
65 #define OC_RSRVD_ES_RES_TYPE_PROV "ocf.wk.prov"
66 #define OC_RSRVD_ES_URI_PROV "/ProvisioningResURI"
67 #define OC_RSRVD_ES_RES_TYPE_WIFI "ocf.wk.wifi"
68 #define OC_RSRVD_ES_URI_WIFI "/WiFiProvisioningResURI"
69 #define OC_RSRVD_ES_RES_TYPE_CLOUDSERVER "ocf.wk.cloudserver"
70 #define OC_RSRVD_ES_URI_CLOUDSERVER "/CloudServerProvisioningResURI"
71 #define OC_RSRVD_ES_RES_TYPE_DEVCONF "ocf.wk.devconf"
72 #define OC_RSRVD_ES_URI_DEVCONF "/DevConfProvisioningResURI"
74 #define NUM_WIFIMODE 10
75 #define MAX_SSIDLEN 33
76 #define MAX_CREDLEN 20
78 #define MAX_DEVICELEN 100
79 #define MAX_WEBLINKLEN 100
82 * @brief Supported WIFI frequency like 2.4G and 5G
86 WIFI_24G = 0, /**< 2.4G **/
88 WIFI_BOTH, /**< 2.4G and 5G **/
89 WIFI_FREQ_NONE /**< EOF **/
93 * @brief Supported WIFI mode like 802.11g and 802.11n
97 WIFI_11A = 0, /**< 802.11a **/
98 WIFI_11B, /**< 802.11b **/
99 WIFI_11G, /**< 802.11g **/
100 WIFI_11N, /**< 802.11n **/
101 WIFI_11AC, /**< 802.11ac **/
107 * @brief WIFI Authentication tlype of the Enroller
111 NONE_AUTH = 0, /**< NO authentication **/
113 WPA_PSK, /**< WPA-PSK **/
114 WPA2_PSK /**< WPA2-PSK **/
118 * @brief WIFI encryption type of the Enroller
122 NONE_ENC = 0, /**< NO encryption **/
123 WEP_64, /**< WEP-64 **/
124 WEP_128, /**< WEP-128**/
127 TKIP_AES /**< TKIP-AES **/
136 ES_NETWORKNOTCONNECTED,
137 ES_RESOURCECREATED = 11,
138 ES_RECVREQOFPROVRES = 21,
140 ES_RECVUPDATEOFPROVRES,
141 ES_RECVTRIGGEROFPROVRES,
142 ES_UNAUTHORIZED = 31,
143 ES_UNSUPPORTED_OPERATION = 41
147 * @brief Indicate which resource is created in Enrollee
151 ES_WIFI_RESOURCE = 0x01,
152 ES_CLOUD_RESOURCE = 0x02,
153 ES_DEVCONF_RESOURCE = 0x04
157 * @brief Indicate enrollee and provisioning status. Provisioning status is shown in "provisioning
158 * status" property in provisioning resource.
163 * Default state of the device
168 * Status indicating being cnnecting to target network
170 ES_STATE_CONNECTING_TO_ENROLLER,
173 * Status indicating successful conection to target network
175 ES_STATE_CONNECTED_TO_ENROLLER,
178 * Status indicating failure connection to target network
180 ES_STATE_CONNECTED_FAIL_TO_ENROLLER,
183 * Status indicating successful registration to cloud
185 ES_STATE_REGISTERED_TO_CLOUD,
188 * Status indicating failure registeration to cloud
190 ES_STATE_REGISTRRED_FAIL_TO_CLOUD
191 } ESEnrolleeState, ProvStatus;
194 * @brief Indicate last error code to describe a reason of error during easy setup.
201 ES_ERRCODE_NO_ERROR = 0,
204 * Error Code that given WiFi's SSID is not found
206 ES_ERRCODE_SSID_NOT_FOUND,
209 * Error Code that given WiFi's Password is wrong
214 * Error Code that IP address is not allocated
216 ES_ERRCODE_IP_NOT_ALLOCATED,
219 * Error Code that there is no Internet connection
221 ES_ERRCODE_NO_INTERNETCONNECTION,
224 * Error Code that Timeout occured
229 * Error Code that Unknown error occured
238 #endif //ES_COMMON_H_