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 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
36 #define OIC_STRING_MAX_VALUE 100
37 #define IPV4_ADDR_SIZE 16
39 #define NET_WIFI_SSID_SIZE 100
40 #define NET_WIFI_PWD_SIZE 100
43 * @brief Mac address length for BT port
45 #define NET_MACADDR_SIZE 18
48 * Attributes used to form a proper easysetup conforming JSON message.
50 #define OC_RSRVD_ES_PS "ps"
51 #define OC_RSRVD_ES_TNN "tnn"
52 #define OC_RSRVD_ES_CD "cd"
53 #define OC_RSRVD_ES_TR "tr"
54 #define OC_RSRVD_ES_TNT "tnt"
55 #define OC_RSRVD_ES_ANT "ant"
56 #define OC_RSRVD_ES_URI_PROV "/oic/prov"
57 #define OC_RSRVD_ES_URI_NET "/oic/net"
60 * @brief Defines for Provisioning status accepted values
62 #define ES_PS_NEED_PROVISIONING 1
63 #define ES_PS_PROVISIONING_COMPLETED 2
66 * Device Roles defined for each device type used in easy setup
76 * On-boarding connection to create Adhoc network.
90 ES_NETWORKNOTCONNECTED,
91 ES_RESOURCECREATED = 11,
92 ES_RECVREQOFPROVRES = 21,
94 ES_RECVUPDATEOFPROVRES,
95 ES_RECVTRIGGEROFPROVRES,
101 * Default state of the device
106 * Device will move to this state once the on boarding begins
108 ES_ON_BOARDING_STATE,
111 * Device will move to this state after successful on-boarding of the device
116 * Device will move to this state once the on boarding is done
118 ES_PROVISIONING_STATE,
121 * Easy setup process is successful.
123 ES_PROVISIONED_STATE,
126 * This state is arbitrary one, any time device can come into this state
127 * Device will move to this state if the ownership transfer initiated by the Application
129 ES_OWNERSHIP_TRANSFERRING_STATE,
132 * This state is arbitrary one, any time device can come into this state
133 * Device will move to this state if the ownership transfer is completed
135 ES_OWNERSHIP_TRANSFERRED_STATE,
138 * This state is arbitrary one, any time device can come into this state
139 * Device will move to this state once the Application factory reset the device
141 ES_FACTORY_RESET_STATE,
144 * Enrollee moves to this state after connecting to target network
146 ES_ON_BOARDED_TARGET_NETWORK_STATE,
150 * Provisioning Device Status
154 // Address of remote server
156 // Indicates adaptor type on which the response was received
157 OCConnectivityType connType;
158 } EasySetupDeviceInfo;
161 * Provosioning Status
165 DEVICE_PROVISIONED = 0,
166 DEVICE_NOT_PROVISIONED,
169 } EasySetupState, ProvStatus;
172 * Response from queries to remote servers.
177 EasySetupState provStatus;
178 // EasySetup Device Info
179 EasySetupDeviceInfo provDeviceInfo;
180 } EasySetupInfo, ProvisioningInfo;
183 * @brief Network information of the Enroller
188 * @brief BT Mac Information
192 char btMacAddress[NET_MACADDR_SIZE]; /**< BT mac address **/
196 * @brief LE MAC Information
200 char leMacAddress[NET_MACADDR_SIZE]; /**< BLE mac address **/
204 * @brief IP Information
208 char ipAddress[IPV4_ADDR_SIZE]; /**< IP Address of the Enroller**/
209 char ssid[NET_WIFI_SSID_SIZE]; /**< ssid of the Enroller**/
210 char pwd[NET_WIFI_PWD_SIZE]; /**< pwd of the Enroller**/
216 * @brief Network Information
220 EnrolleeInfo netAddressInfo; /**< Enroller Network Info**/
221 OCConnectivityType connType; /**< Connectivity Type**/
222 bool isSecured; /**< Secure connection**/
223 // TODO : Ideally isSecured should be renamed to needSecuredEasysetup.
224 // To provide backward compatibility to v1.0 release, a new variable is being added.
225 // If isSecured is not used by other applications, isSecured will be depricated.
226 bool needSecuredEasysetup; /**< Need of secure ownership transfer during easysetup**/
227 } EnrolleeNWProvInfo;
230 * Client applications implement this callback to consume responses received from Servers.
232 typedef void (*OCProvisioningStatusCB)(EasySetupInfo *easySetupInfo);
234 #endif //ES_COMMON_H_