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 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
28 #define OIC_STRING_MAX_VALUE 100
29 #define IPV4_ADDR_SIZE 16
31 #define NET_WIFI_SSID_SIZE 100
32 #define NET_WIFI_PWD_SIZE 100
35 * @brief Mac address length for BT port
37 #define NET_MACADDR_SIZE 18
40 * Attributes used to form a proper easysetup conforming JSON message.
42 #define OC_RSRVD_ES_PROVSTATUS "ps"
43 #define OC_RSRVD_ES_ERRORCODE "ec"
44 #define OC_RSRVD_ES_TRIGGER "tr"
45 #define OC_RSRVD_ES_SUPPORTEDWIFIMODE "swmt"
46 #define OC_RSRVD_ES_SUPPORTEDWIFIFREQ "swf"
47 #define OC_RSRVD_ES_SSID "tnn"
48 #define OC_RSRVD_ES_CRED "cd"
49 #define OC_RSRVD_ES_AUTHTYPE "wat"
50 #define OC_RSRVD_ES_ENCTYPE "wet"
51 #define OC_RSRVD_ES_AUTHCODE "ac"
52 #define OC_RSRVD_ES_AUTHPROVIDER "apn"
53 #define OC_RSRVD_ES_CISERVER "cisurl"
54 #define OC_RSRVD_ES_DEVNAME "dn"
55 #define OC_RSRVD_ES_LANGUAGE "lang"
56 #define OC_RSRVD_ES_COUNTRY "cont"
59 * Easysetup defined resoruce types and uris.
61 #define OC_RSRVD_ES_RES_TYPE_PROV "ocf.r.prov"
62 #define OC_RSRVD_ES_URI_PROV "/.well-known/ocf/prov"
63 #define OC_RSRVD_ES_RES_TYPE_WIFI "ocf.r.wifi"
64 #define OC_RSRVD_ES_URI_WIFI "/.well-known/ocf/prov/wifi"
65 #define OC_RSRVD_ES_RES_TYPE_CLOUDSERVER "ocf.r.cloudserver"
66 #define OC_RSRVD_ES_URI_CLOUDSERVER "/.well-known/ocf/prov/cloudserver"
67 #define OC_RSRVD_ES_RES_TYPE_DEVCONF "ocf.r.devconf"
68 #define OC_RSRVD_ES_URI_DEVCONF "/.well-known/ocf/prov/devconf"
70 #define OC_RSRVD_ES_URI_NET "/oic/net"
72 #define NUM_WIFIMODE 10
74 #define MAXNETCREDLEN 20
118 * Device Roles defined for each device type used in easy setup
128 * On-boarding connection to create Adhoc network.
142 ES_NETWORKNOTCONNECTED,
143 ES_RESOURCECREATED = 11,
144 ES_RECVREQOFPROVRES = 21,
146 ES_RECVUPDATEOFPROVRES,
147 ES_RECVTRIGGEROFPROVRES,
152 ES_WIFI_RESOURCE = 0x01,
153 ES_CLOUD_RESOURCE = 0x02,
154 ES_DEVCONF_RESOURCE = 0x04
159 char ssid[NET_WIFI_SSID_SIZE]; /**< ssid of the Enroller**/
160 char pwd[NET_WIFI_PWD_SIZE]; /**< pwd of the Enroller**/
161 WIFI_AUTHTYPE authtype; /**< auth type of the Enroller**/
162 WIFI_ENCTYPE enctype; /**< encryption type of the Enroller**/
167 char language[OIC_STRING_MAX_VALUE];
168 char country[OIC_STRING_MAX_VALUE];
173 char authCode[OIC_STRING_MAX_VALUE];
174 char authProvider[OIC_STRING_MAX_VALUE];
175 char ciServer[OIC_STRING_MAX_VALUE];
179 // TODO : Need to be erased
183 * Default state of the device
188 * Device will move to this state once the on boarding begins
190 ES_ON_BOARDING_STATE,
193 * Device will move to this state after successful on-boarding of the device
198 * Device will move to this state once the on boarding is done
200 ES_PROVISIONING_STATE,
203 * Easy setup process is successful.
205 ES_PROVISIONED_STATE,
208 * This state is arbitrary one, any time device can come into this state
209 * Device will move to this state if the ownership transfer initiated by the Application
211 ES_OWNERSHIP_TRANSFERRING_STATE,
214 * This state is arbitrary one, any time device can come into this state
215 * Device will move to this state if the ownership transfer is completed
217 ES_OWNERSHIP_TRANSFERRED_STATE,
220 * This state is arbitrary one, any time device can come into this state
221 * Device will move to this state once the Application factory reset the device
223 ES_FACTORY_RESET_STATE,
226 * Enrollee moves to this state after connecting to target network
228 ES_ON_BOARDED_TARGET_NETWORK_STATE,
232 * Provisioning Device Status
236 // Address of remote server
238 // Indicates adaptor type on which the response was received
239 OCConnectivityType connType;
240 } EasySetupDeviceInfo;
243 * Provosioning Status
247 DEVICE_PROVISIONED = 0,
248 DEVICE_NOT_PROVISIONED,
251 } EasySetupState, ProvStatus;
254 * Response from queries to remote servers.
259 EasySetupState provStatus;
260 // EasySetup Device Info
261 EasySetupDeviceInfo provDeviceInfo;
262 } EasySetupInfo, ProvisioningInfo;
265 * @brief Network information of the Enroller
270 * @brief BT Mac Information
274 char btMacAddress[NET_MACADDR_SIZE]; /**< BT mac address **/
278 * @brief LE MAC Information
282 char leMacAddress[NET_MACADDR_SIZE]; /**< BLE mac address **/
286 * @brief IP Information
290 char ssid[NET_WIFI_SSID_SIZE]; /**< ssid of the Enroller**/
291 char pwd[NET_WIFI_PWD_SIZE]; /**< pwd of the Enroller**/
296 * @brief Network Information
300 ProvData provData; /**< Enroller Network Info**/
301 OCConnectivityType connType; /**< Connectivity Type**/
305 * Client applications implement this callback to consume responses received from Servers.
307 typedef void (*OCProvisioningStatusCB)(EasySetupInfo *easySetupInfo);
310 * @brief This structure represent configuration information to create wifi onboarding SoftAP or connection.
314 // Note : Below structure is not currently used but added for future purpose.
316 char ssid[NET_WIFI_SSID_SIZE]; /**< ssid of the onboarding Adhoc Wifi network**/
317 char pwd[NET_WIFI_PWD_SIZE]; /**< pwd of the onboarding Adhoc wifi network**/
318 bool isSecured; /**< Secure connection**/
319 }WiFiOnboardingConfig;
322 * @brief This structure represent onboarding connection instance.
325 /*Actual use of ipAddress is for unicast discovery, but also used to identify the Enrollee device as of now,
326 device identification should be based on DeviceID in next release.*/
327 char ipAddress[IPV4_ADDR_SIZE]; /**< IP Address of the Enrollee **/
328 bool isSecured; /**< Secure connection**/
329 }WiFiOnboadingConnection;
332 #endif //ES_COMMON_H_