resource/releaseNotes/Sept2nd2014.txt

   1 Release notes
   2 ****************************************************************************
   3 Release date: Sept 2nd, 2014.
   4 OS: Ubuntu 12.0.4 and above
   5 Requires boost version 1.55 to build.
   6 Code buildable in gcc 4.6.3 and above.
   7 NOTE: Boost is not distributed but should be installed in the Ubuntu machine.
   8 *****************************************************************************
   9
  10 What\92s new?
  11
  12 --------------------------------------------
  13 Class OCPlatform (Header file: OCPlatform.h)
  14 --------------------------------------------
  15
  16 *****************
  17 startPresence API
  18 *****************
  19
  20 This API allows the server to notify its presence via multicast.
  21
  22 NOTE: This applies to server side functionality only.
  23
  24 *******************
  25 stopPresence API
  26 *******************
  27
  28 This API allows the server to stop presence notification.
  29
  30 NOTE: This applies to server side functionality.
  31
  32
  33 ******************
  34 subscribePresence API
  35 ******************
  36
  37 This API allows a client to subscribe to a device's presence notifications. Notifications include new addition of resource on the device, deletion of a resource on the device, change in properties of a resource.
  38
  39 NOTE: This applies to client side functionality only.
  40 NOTE: In this release, when client uses subscribePresence API, it gets notified only for new addition of resource on the device (server).
  41
  42 *******************
  43 unsubscribePresence API
  44 *******************
  45
  46 This API allows a client to unsubscribe from a device's presence events.
  47
  48 NOTE: This applies to client side functionality only.
  49
  50 --------------------------------------------
  51  Header file: OCStack.h (in base)
  52 --------------------------------------------
  53
  54 *****************
  55 OCStartPresence API
  56 *****************
  57
  58 This API will start sending out presence notifications to clients via multicast.
  59
  60 NOTE: This applies to server side functionality only.
  61
  62 *******************
  63 OCStopPresence API
  64 *******************
  65
  66 This API will stop sending out presence notifications to clients via multicast.
  67
  68 NOTE: This applies to server side functionality.
  69
  70 ------------
  71 Other Notes:
  72 ------------
  73
  74 Security model is still open.
  75 APIs have OCStackResult as return type. This is will indicate success or failure for the API operation.
  76
  77 Implementation for presence code is in both C (base) and C++ (SDK). In C (base) stack, presence code is defined with 'WITH_PRESENCE' preprocessor macro.
  78
  79 Maximum length of URI supported is 64 bytes (sent from the client)
  80 Maximum length of query supported is 64 bytes (sent from the client)
  81 Maximum length of request and response from server for Ardunio is is 256 bytes
  82 Maximum length of request and response from server for non-Ardunio is is 1024 bytes
  83
  84 -------------
  85 How to build:
  86 -------------
  87
  88 REFER https://oic-review.01.org/gerrit for more details on getting oic-resource repo.
  89 If the code is not cloned:
  90 Clone the oic-resource repo using this command: git clone oic:oic-resource
  91 Clone the oic-utilities repo using this command: git clone oic:oic-utilities
  92
  93 NOTE: If the repo is already cloned, use 'git pull' inside oic-resource folder to get the latest code.
  94
  95 In repo oic-core, root folder ccf-opensource consists of \91OIC\92 folder.  Inside OIC folder there is a Makefile.
  96
  97 Before building, make sure to have contents from oic-utilities repo at the folder level where oic-resource is.
  98
  99 Inside oic-resource directory, use \91make\92 to build the entire OIC code. This would build the C++ SDK, core(i.e base) and samples.
 100
 101 Use \91make BUILD=debug\92 to build the entire OIC code in debug mode. This would build the C++ SDK, core(i.e base) and samples. All the executables for debug build
 102 are in 'debug/samples'.
 103
 104 --------
 105 Samples:
 106 --------
 107
 108 After building the code in oic-resource, executables are in directory named 'release/samples'.
 109 A sample for hosting a resource on a server and a sample for client for discovering resources are provided in the following paths:
 110
 111 Server sample location: oic-resource/examples/simpleserver.cpp
 112 Client sample location: oic-resource/examples/simpleclient.cpp
 113 Server and client mode (mode type both) location: oic-resource/examples/simpleclientserver.cpp
 114
 115 Sample with basic presence feature for server side: oic-resource/examples/presenceserver.cpp
 116 Sample with basic presence feature for client side: oic-resource/examples/presenceclient.cpp