resource/releaseNotes/Oct31st2014.txt

   1 Release notes
   2 ****************************************************************************
   3 Release date: Oct 31st, 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 Release commit number: c8ba162fe83db3832ae889a0cb31904d888826d1
  11
  12 What is new?
  13
  14 --------------------------------------------
  15 Class OCPlatform (Header file: OCPlatform.h)
  16 --------------------------------------------
  17 This release includes support for using OCPlatform instance in multiple threads.
  18 OCPlatform functions are now supported to be called from multiple threads.
  19 Applications need not create OCPlatform object explicitly.
  20
  21
  22 ***************
  23 Configure API
  24 ***************
  25 Applications can set the PlatformConfig and then invoke new API "Configure" in OCPlatform.h.
  26 NOTE: This API is optional. First time an OCPlatform API is called, stack creates the singleton
  27 instance internally. After which, setting the configuration will have no effect.
  28
  29 NOTE: OCPlatform functions can be called without OCPlatform instance.
  30 Sample:
  31
  32 OCStackResult result = OCPlatform::registerResource(... );
  33
  34 NOTE: For clarity, registerResource parameters are not shown above.
  35 NOTE: Iotivity stack internally creates a singleton instance.
  36 NOTE: C++ sample applications are updated accordingly. Please refer oic-resource/examples
  37
  38 ------------
  39 Other Notes:
  40 ------------
  41
  42 Security model is still open.
  43
  44 Maximum length of URI supported is 64 bytes (sent from the client)
  45 Maximum length of query supported is 64 bytes (sent from the client)
  46 Maximum length of request and response from server for Ardunio is is 256 bytes
  47 Maximum length of request and response from server for non-Ardunio is is 1024 bytes
  48
  49 OIC base supports Arduino WiFi shield.
  50 This support has been tested with Arduino Mega 2560 and with Arduino 1.0.5 WiFi library.
  51 Please refer to oic-resource/csdk/README file for building OIC base with WiFi support.
  52
  53 Minor bug fixes done.
  54
  55 Simple attribute sample update:
  56 This release has updates to roomserver and roomclient applications to demonstrate simple
  57 attribute support in collections.
  58
  59 C++ unit test infrastructure:
  60 This release includes infrastructure for C++ unit tests (oic-resource/unittests)
  61 -------------
  62 How to build:
  63 -------------
  64
  65 REFER https://oic-review.01.org/gerrit for more details on getting oic-resource repo.
  66 If the code is not cloned:
  67 Clone the oic-resource repo using this command: git clone oic:oic-resource
  68 Clone the oic-utilities repo using this command: git clone oic:oic-utilities
  69
  70 NOTE: If the repo is already cloned, use 'git pull' inside oic-resource folder to get the latest code.
  71
  72 In repo oic-core, root folder ccf-opensource consists of 'OIC' folder.  Inside OIC folder there is a Makefile.
  73
  74 Before building, make sure to have contents from oic-utilities repo at the folder level where oic-resource is.
  75
  76 Inside oic-resource directory, use 'make'to build the entire OIC code. This would build the C++ SDK, core(i.e base) and samples.
  77
  78 Use 'make BUILD=debug' 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
  79 are in 'oic-resource/debug'.
  80
  81 --------
  82 Samples:
  83 --------
  84
  85 A basic sample for hosting a resource on a server and a sample for client for discovering resources are provided here:
  86 Simple server sample location: oic-resource/examples/simpleserver.cpp
  87 Simple client sample location: oic-resource/examples/simpleclient.cpp
  88 Server and client mode (mode type both) location: oic-resource/examples/simpleclientserver.cpp
  89 Simpleserver and simpleclient samples also provide examples for doing POST operation.
  90
  91 Garage samples provide usage of OCRepresentation, get/set attribute values
  92 oic-resource/examples/garageclient.cpp
  93 oic-resource/examples/garageserver.cpp
  94
  95 Fridge samples provide usage of constructResourceObject API, std bind (for mapping request and responses), default
  96 device entity handler, header options support and Delete operation.
  97 oic-resource/examples/fridgeclient.cpp
  98 oic-resource/examples/fridgeserver.cpp
  99
 100 Presence samples provides examples to use presence APIs
 101 Sample with basic presence feature for server side: oic-resource/examples/presenceserver.cpp
 102 Sample with basic presence feature for client side: oic-resource/examples/presenceclient.cpp
 103
 104 Room samples provides examples to use resource collection.
 105 oic-resource/examples/roomclient.cpp
 106 oic-resource/examples/roomserver.cpp
 107
 108 After building the code in oic-resource, executables for samples are in directory named 'oic-resource/samples/release'.
 109 After building the code in oic-resource, executables are in directory named 'oic-resource/release'.
 110