examples/OICMiddle/README

   1 OICMiddle was written to
   2 * be part of a demonstration of OIC Yocto capability,
   3 * act as an example of resource callbacks using class methods,
   4 * provide a simple promiscuous resource editor for examining OIC systems, and
   5 * act as a starting code base for further exploration of OIC capabilities.
   6
   7 As a demonstration, it runs on an Minnowboard running a Yocto-built OS, acting
   8 as a gateway between an Android device (acting as an OIC client) and an
   9 Edison board (acting as an OIC server) with sensors and actuators.
  10
  11 As an example of resource callbacks, it shows a method of using class methods
  12 as callbacks, a critical capability not shown in any of the examples in
  13 iotivity/resource/examples.
  14
  15 As a promiscuous resource editor, it can find, get, put and observe any
  16 resource using a simple command-line interface using the system console.
  17
  18 As a code base, the command-line editor can be the basis for adding additional
  19 editing capabilities, like the additions of various filters.
  20
  21 Running OICMiddle with no arguments on a console shows the various capabilities
  22 it offers.  The most important are:
  23  -client.   Act as an OIC client.
  24  -console.  Accept command lines from console input to drive the OIC client.
  25  -server.   Advertise resources found by the OIC client as OIC resources.
  26
  27 The -server capabilites might be the basis for a gateway.
  28
  29 Typing 'help' (or invalid commands) to the console gives a console usage
  30 message.  The important ones are:
  31  find       Find all resources.  Also performed automatically at startup.
  32  show       Show the found resources and an assigned index.
  33  get        Get the value(s) of the resource with the given index.
  34  put        Put one or more resource values for the given index.
  35
  36
  37 12/24/2014