resource/releaseNotes/Dec20th2014.txt

   1 Release notes
   2 ****************************************************************************
   3 Release date: Dec 20th, 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 is new?
  11
  12 Features:
  13 ---------
  14
  15 Device discovery:
  16 -----------------
  17 The device description resource is a virtual resource that provides a representation
  18 that contains information about the device. It provides a standard mechanism to query
  19 well-known device meta-data including but not limited to device id, name etc. Device
  20 discovery feature provides a mechanism to find devices based on specific device-level
  21 attributes.
  22
  23 Samples demonstrating device discovery:
  24 devicediscoveryserver and devicediscoveryclient in C++
  25 ocserver and occlient in C
  26
  27
  28 ------------
  29 API changes:
  30 ------------
  31
  32 --------------------------------------------
  33 Class OCPlatform (Header file: OCPlatform.h)
  34 --------------------------------------------
  35
  36 ***********************
  37 registerDeviceInfo API
  38 ***********************
  39
  40 This new API allows server app to provide the device information.
  41
  42 ***********************
  43 getDeviceInfo API
  44 ***********************
  45
  46 This new API allows client app to find the device and get the device information.
  47
  48 --------------------------------------------
  49 Header file: ocstack.h
  50 --------------------------------------------
  51
  52 ***********************
  53 OCSetDeviceInfo API
  54 ***********************
  55
  56 This new API allows to set the device information.
  57
  58
  59 ------------
  60 Notes:
  61 ------------
  62 1. Multiple improvements in active discovery/presence
  63 - Callback includes host information
  64 - Added support to allow more than one presence resource type filter
  65
  66 2. Klocwork issues fixed in C++ samples, SDK and C samples.
  67
  68 3. Multiple bug fixes updated in Jira.
  69
  70 General notes:
  71 --------------
  72 Maximum length of URI supported is 64 bytes (sent from the client)
  73 Maximum length of query supported is 64 bytes (sent from the client)
  74 Maximum length of request from client and response from server for Arduino is is 256 bytes
  75 Maximum length of request from client and response from server for non-Ardunio is is 1024 bytes
  76
  77 OIC base supports Arduino WiFi shield.
  78 This support has been tested with Arduino Mega 2560 and with Arduino 1.0.5 WiFi library.
  79 Please refer to oic-resource/csdk/README file for building OIC base with WiFi support.
  80
  81 --------
  82 Samples:
  83 --------
  84
  85 C++ Samples
  86 -----------
  87
  88 A basic sample for hosting a resource on a server and a sample for client for discovering resources
  89 are provided here:
  90 Simple server sample location: oic-resource/examples/simpleserver.cpp
  91 Simple client sample location: oic-resource/examples/simpleclient.cpp
  92 Server and client mode (mode type both) location: oic-resource/examples/simpleclientserver.cpp
  93 Simpleserver and simpleclient samples also provide examples for doing POST operation.
  94 Simpleserver also demonstrates slow response case for a GET request.
  95
  96 Garage samples provide usage of OCRepresentation, get/set attribute values
  97 oic-resource/examples/garageclient.cpp
  98 oic-resource/examples/garageserver.cpp
  99
 100 Fridge samples provide usage of constructResourceObject API, std bind
 101 (for mapping request and responses), default
 102 device entity handler, header options support and Delete operation.
 103 oic-resource/examples/fridgeclient.cpp
 104 oic-resource/examples/fridgeserver.cpp
 105
 106 Presence samples provides examples to use presence APIs
 107 Sample with basic presence feature for server side: oic-resource/examples/presenceserver.cpp
 108 Sample with basic presence feature for client side: oic-resource/examples/presenceclient.cpp
 109
 110 Room samples provides examples to use resource collection.
 111 oic-resource/examples/roomclient.cpp
 112 oic-resource/examples/roomserver.cpp
 113
 114 After building the code in oic-resource, executables for samples are in directory named
 115 'oic-resource/samples/release'.
 116 After building the code in oic-resource, executables are in directory named 'oic-resource/release'.
 117
 118 C Samples
 119 ---------
 120 Collection samples are demonstrated in:
 121 ocservercoll and occlientcoll
 122
 123 Slow response feature is demonstrated in:
 124 ocserverslow and occlientslow
 125
 126 Client and server basic operations -- discovery, GET, PUT, POST (NON messages) demonstrated in:
 127 ocserverbasicops and occlientbasicops
 128
 129 Client and server - discovery, GET,PUT,POST,DELETE,OBS for both NON and CON demonstrated in:
 130 ocserver and occlient