resource/csdk/stack/samples/arduino/SimpleClientServer/ocserver/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 This makefile relies on "local.properties" at the directory level of the
  22 makefile that generates octbstack.a. Please refer to the README at that level
  23 to determine what definitions are needed for your environment.
  24
  25 To make ocserver in release mode:
  26
  27         make (arduinomega)
  28     make -f makefiledue (arduinodue)
  29
  30 To make & install ocserver in release mode, with <DEV_PORT> NOT specified:
  31
  32         make install (arduinomega)
  33     make -f makefiledue install (arduinodue)
  34
  35 To make & install ocserver in release mode, with <DEV_PORT> specified:
  36
  37         make install ARDUINO_PORT=<DEV_PORT>
  38
  39 To make & install ocserver in debug mode, with <DEV_PORT> specified:
  40
  41         make install ARDUINO_PORT=<DEV_PORT> BUILD=debug
  42
  43 To make ocserver_wifi with Arduino WiFi Shield support:
  44
  45         make ARDUINOWIFI=1 (arduinomega)
  46 -------------------------------------------------------------------------------
  47 **Clean-Up**
  48 -------------------------------------------------------------------------------
  49 To clean ocserver sample app and objects:
  50
  51         make clean