resource/releaseNotes/Jan17th2015.txt

   1 Release notes
   2 ****************************************************************************
   3 Release date: Jan 17th, 2015.
   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 Branch: master
  11 ***************
  12
  13 What is new?
  14
  15 1. OICSensorBoard Sample app added for Intel Edison platform
  16 - Location: iotivity/examples/OICSensorBoard
  17 - Details and instructions provided in iotivity/examples/OICSensorBoard/OICSensorBoardREADME.pdf
  18
  19 2. OICMiddle Sample app added for demonstrating OIC Yocto capability
  20 - Location: iotivity/examples/OICMiddle
  21 - Details and instructions provided in iotivity/examples/OICMiddle/README
  22
  23 3. Multiple bug fixes updated in Jira.
  24
  25 General notes:
  26 --------------
  27 Maximum length of URI supported is 64 bytes (sent from the client)
  28 Maximum length of query supported is 64 bytes (sent from the client)
  29 Maximum length of request from client and response from server for Arduino is is 256 bytes
  30 Maximum length of request from client and response from server for non-Ardunio is is 1024 bytes
  31
  32 OIC base supports Arduino WiFi shield.
  33 This support has been tested with Arduino Mega 2560 and with Arduino 1.0.5 WiFi library.
  34 Please refer to oic-resource/csdk/README file for building OIC base with WiFi support.
  35
  36 --------
  37 Samples:
  38 --------
  39
  40 C++ Samples
  41 -----------
  42
  43 A basic sample for hosting a resource on a server and a sample for client for discovering resources
  44 are provided here:
  45 Simple server sample location: oic-resource/examples/simpleserver.cpp
  46 Simple client sample location: oic-resource/examples/simpleclient.cpp
  47 Server and client mode (mode type both) location: oic-resource/examples/simpleclientserver.cpp
  48 Simpleserver and simpleclient samples also provide examples for doing POST operation.
  49 Simpleserver also demonstrates slow response case for a GET request.
  50
  51 Garage samples provide usage of OCRepresentation, get/set attribute values
  52 oic-resource/examples/garageclient.cpp
  53 oic-resource/examples/garageserver.cpp
  54
  55 Fridge samples provide usage of constructResourceObject API, std bind
  56 (for mapping request and responses), default
  57 device entity handler, header options support and Delete operation.
  58 oic-resource/examples/fridgeclient.cpp
  59 oic-resource/examples/fridgeserver.cpp
  60
  61 Presence samples provides examples to use presence APIs
  62 Sample with basic presence feature for server side: oic-resource/examples/presenceserver.cpp
  63 Sample with basic presence feature for client side: oic-resource/examples/presenceclient.cpp
  64
  65 Room samples provides examples to use resource collection.
  66 oic-resource/examples/roomclient.cpp
  67 oic-resource/examples/roomserver.cpp
  68
  69 After building the code in oic-resource, executables for samples are in directory named
  70 'oic-resource/samples/release'.
  71 After building the code in oic-resource, executables are in directory named 'oic-resource/release'.
  72
  73 C Samples
  74 ---------
  75 Collection samples are demonstrated in:
  76 ocservercoll and occlientcoll
  77
  78 Slow response feature is demonstrated in:
  79 ocserverslow and occlientslow
  80
  81 Client and server basic operations -- discovery, GET, PUT, POST (NON messages) demonstrated in:
  82 ocserverbasicops and occlientbasicops
  83
  84 Client and server - discovery, GET,PUT,POST,DELETE,OBS for both NON and CON demonstrated in:
  85 ocserver and occlient