service/easy-setup/inc/escommon.h

   1 //******************************************************************
   2 //
   3 // Copyright 2015 Samsung Electronics All Rights Reserved.
   4 //
   5 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
   6 //
   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
  10 //
  11 //      http://www.apache.org/licenses/LICENSE-2.0
  12 //
  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.
  18 //
  19 //-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=
  20
  21 #ifndef ES_COMMON_H_
  22 #define ES_COMMON_H_
  23
  24 #include "ocstack.h"
  25 #include "octypes.h"
  26
  27 #ifdef __cplusplus
  28 extern "C"
  29 {
  30 #endif
  31
  32 // Defines
  33 #define OIC_STRING_MAX_VALUE    100
  34 #define IPV4_ADDR_SIZE          16
  35 #define IP_PORT                 55555
  36
  37 /**
  38  * @brief Mac address length for BT port
  39  */
  40 #define NET_MACADDR_SIZE 18
  41
  42 /**
  43  * Attributes used to form a proper easysetup conforming JSON message.
  44  */
  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"
  61
  62 /**
  63  * Easysetup defined resoruce types and uris.
  64  */
  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"
  73
  74 #define NUM_WIFIMODE    10
  75 #define MAX_SSIDLEN     33
  76 #define MAX_CREDLEN     20
  77
  78 #define MAX_DEVICELEN   100
  79 #define MAX_WEBLINKLEN  100
  80
  81 /**
  82  * @brief  Supported WIFI mode like 802.11g and 802.11n
  83  */
  84 typedef enum
  85 {
  86     WiFi_11A = 0,       /**< 802.11a **/
  87     WiFi_11B,           /**< 802.11b **/
  88     WiFi_11G,           /**< 802.11g **/
  89     WiFi_11N,           /**< 802.11n **/
  90     WiFi_11AC,          /**< 802.11ac **/
  91     WiFi_EOF = 999
  92 } WIFI_MODE;
  93
  94 /**
  95  * @brief  Supported WIFI frequency like 2.4G and 5G
  96  */
  97 typedef enum
  98 {
  99     WiFi_24G = 0,       /**< 2.4G **/
 100     WiFi_5G,            /**< 5G **/
 101     WiFi_BOTH           /**< 2.4G and 5G **/
 102 } WIFI_FREQ;
 103
 104 /**
 105  * @brief  WIFI Authentication tlype of the Enroller
 106  */
 107 typedef enum
 108 {
 109     NONE_AUTH = 0,      /**< NO authentication **/
 110     WEP,                /**< WEP **/
 111     WPA_PSK,            /**< WPA-PSK **/
 112     WPA2_PSK            /**< WPA2-PSK **/
 113 } WIFI_AUTHTYPE;
 114
 115 /**
 116  * @brief  WIFI encryption type of the Enroller
 117  */
 118 typedef enum
 119 {
 120     NONE_ENC = 0,       /**< NO encryption **/
 121     WEP_64,             /**< WEP-64 **/
 122     WEP_128,            /**< WEP-128**/
 123     TKIP,               /**< TKIP **/
 124     AES,                /**< AES **/
 125     TKIP_AES            /**< TKIP-AES **/
 126 } WIFI_ENCTYPE;
 127
 128 typedef enum
 129 {
 130     ES_ERROR = -1,
 131     ES_OK = 0,
 132     ES_NETWORKFOUND = 1,
 133     ES_NETWORKCONNECTED,
 134     ES_NETWORKNOTCONNECTED,
 135     ES_RESOURCECREATED = 11,
 136     ES_RECVREQOFPROVRES = 21,
 137     ES_RECVREQOFNETRES,
 138     ES_RECVUPDATEOFPROVRES,
 139     ES_RECVTRIGGEROFPROVRES,
 140     ES_UNAUTHORIZED = 31
 141 } ESResult;
 142
 143 /**
 144  * @brief Indicate which resource is created in Enrollee
 145  */
 146 typedef enum
 147 {
 148     ES_WIFI_RESOURCE = 0x01,
 149     ES_CLOUD_RESOURCE = 0x02,
 150     ES_DEVCONF_RESOURCE = 0x04
 151 } ESResourceMask;
 152
 153 /**
 154  * @brief Data structure delivered from mediator, which provides WiFi information
 155  */
 156 typedef struct
 157 {
 158     char ssid[MAX_SSIDLEN];         /**< Ssid of the Enroller**/
 159     char pwd[MAX_CREDLEN];          /**< Pwd of the Enroller**/
 160     WIFI_AUTHTYPE authtype;         /**< Auth type of the Enroller**/
 161     WIFI_ENCTYPE enctype;           /**< Encryption type of the Enroller**/
 162 } ESWiFiProvData;
 163
 164 /**
 165  * @brief Data structure delivered from mediator, which provides device configuration information
 166  */
 167 typedef struct
 168 {
 169     char language[OIC_STRING_MAX_VALUE];    /**< IETF language tag using ISO 639X **/
 170     char country[OIC_STRING_MAX_VALUE];     /**< ISO Country Code (ISO 3166-1 Alpha-2) **/
 171 } ESDevConfProvData;
 172
 173 /**
 174  * @brief Data structure delivered from mediator, which provides Cloud server information
 175  */
 176 typedef struct
 177 {
 178     char authCode[OIC_STRING_MAX_VALUE];        /**< Auth code issued by OAuth2.0-compatible account server **/
 179     char authProvider[OIC_STRING_MAX_VALUE];    /**< Auth provider ID **/
 180     char ciServer[OIC_STRING_MAX_VALUE];        /**< Cloud interface server URL which an Enrollee is going to registered **/
 181     char serverID[OIC_STRING_MAX_VALUE];        /**< Cloud interface server UUID **/
 182 } ESCloudProvData;
 183
 184 /**
 185  * @brief Data structure stored for Device property which includes a WiFi and device configuration.
 186  */
 187 typedef struct
 188 {
 189     /**
 190      * @brief Data structure indicating WiFi configuration of Enrollee
 191      */
 192     struct
 193     {
 194         WIFI_MODE mode[NUM_WIFIMODE];
 195         WIFI_FREQ freq;
 196     } WiFi;
 197
 198     /**
 199      * @brief Data structure indicating device configuration of Enrollee
 200      */
 201     struct
 202     {
 203         char deviceName[MAX_DEVICELEN];
 204     } DevConf;
 205 } ESDeviceProperty;
 206
 207 /**
 208  * @brief Indicate enrollee and provisioning status. Provisioning status is shown in "provisioning
 209  *        status" property in provisioning resource.
 210  */
 211 typedef enum
 212 {
 213     /**
 214      * Default state of the device
 215      */
 216     ES_STATE_INIT = 0,
 217
 218     /**
 219     * Status indicating being cnnecting to target network
 220     */
 221     ES_STATE_CONNECTING_TO_ENROLLER,
 222
 223     /**
 224     * Status indicating successful conection to target network
 225     */
 226     ES_STATE_CONNECTED_TO_ENROLLER,
 227
 228     /**
 229     * Status indicating failure connection to target network
 230     */
 231     ES_STATE_CONNECTED_FAIL_TO_ENROLLER,
 232
 233     /**
 234     * Status indicating successful registration to cloud
 235     */
 236     ES_STATE_REGISTERED_TO_CLOUD,
 237
 238     /**
 239     * Status indicating failure registeration to cloud
 240     */
 241     ES_STATE_REGISTRRED_FAIL_TO_CLOUD
 242 } ESEnrolleeState, ProvStatus;
 243
 244 /**
 245  * @brief Indicate last error code to describe a reason of error during easy setup.
 246  */
 247 typedef enum
 248 {
 249     /**
 250      * Init Error Code
 251      */
 252     ES_ERRCODE_NO_ERROR = 0,
 253
 254     /**
 255     * Error Code that given WiFi's SSID is not found
 256     */
 257     ES_ERRCODE_SSID_NOT_FOUND,
 258
 259     /**
 260     * Error Code that given WiFi's Password is wrong
 261     */
 262     ES_ERRCODE_PW_WRONG,
 263
 264     /**
 265     * Error Code that IP address is not allocated
 266     */
 267     ES_ERRCODE_IP_NOT_ALLOCATED,
 268
 269     /**
 270     * Error Code that there is no Internet connection
 271     */
 272     ES_ERRCODE_NO_INTERNETCONNECTION,
 273
 274     /**
 275     * Error Code that Timeout occured
 276     */
 277     ES_ERRCODE_TIMEOUT,
 278
 279     /**
 280     * Error Code that Unknown error occured
 281     */
 282     ES_ERRCODE_UNKNOWN
 283 } ESErrorCode;
 284
 285 #ifdef __cplusplus
 286 }
 287 #endif
 288
 289 #endif //ES_COMMON_H_