resource/csdk/stack/samples/arduino/SimpleClientServer/README

   1 -------------------------------------------------------------------------------
   2   NOTICE - Transition to SCONS
   3 -------------------------------------------------------------------------------
   4
   5 The IoTivity build system is transitioning to SCONS. Although the
   6 makefiles are still available (until v1.0) and some developers are
   7 still using them, they are currently no longer supported. To learn more
   8 about building using SCONS see Readme.scons.txt in the repository root
   9 directory. The build steps used in continuous integration can be found
  10 in auto_build.sh which is also in the the repository root directory.
  11
  12 -------------------------------------------------------------------------------
  13 **Arduino** -- Must be built with the same BUILD mode declared as octbstack.a.
  14 -------------------------------------------------------------------------------
  15 When an Arduino SimpleClientServer application is running, it outputs logs to
  16 serial port. This requires the current user to be a part of the "dialout" user
  17 group permissions on Ubuntu. If your Arduino device is NOT installed at
  18 location "ttyACM0", you must define ARDUINO_PORT to the location it is
  19 installed at. This location will be referred to as <DEV_PORT>.
  20
  21 You can only install one application at a time. Your choices are "oclient" or
  22 "ocserver." Your selection will be referred to as <DEV_APP>.
  23
  24 This makefile relies on "local.properties" at the directory level of the
  25 makefile that generates octbstack.a. Please refer to the README at that level
  26 to determine what definitions are needed for your environment.
  27
  28 To make occlient or ocserver in release mode:
  29
  30         make
  31
  32 To make & install occlient or ocserver in release mode, with <DEV_PORT> specified:
  33
  34         make install APP_INSTALL=<DEV_APP> ARDUINO_PORT=<DEV_PORT>
  35
  36 To make & install occlient or ocserver in debug mode:
  37
  38         make install APP_INSTALL=<DEV_APP> ARDUINO_PORT=<DEV_PORT> BUILD=debug
  39
  40 -------------------------------------------------------------------------------
  41 **Clean-Up**
  42 -------------------------------------------------------------------------------
  43 To clean occlient & ocserver sample apps and objects:
  44
  45         sudo make clean
  46