resource/csdk/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 **Linux**
  14 -------------------------------------------------------------------------------
  15 To make octbstack.a in release mode:
  16
  17         make
  18
  19 To make octbstack.a in debug mode:
  20
  21         make BUILD=debug
  22
  23 -------------------------------------------------------------------------------
  24 **Arduino**
  25 -------------------------------------------------------------------------------
  26 Touch (i.e. create) file named "local.properties" at this directory level with
  27 the following definition(s):
  28
  29         ARDUINO_DIR = <PATH_TO_ARDUINO_INSTALL_DIR>/arduino-1.0.5
  30     ARDUINO_TOOLS_DIR = <PATH_TO_ARDUINO_TOOLS> (location of avr-g++ and other avr tools)
  31
  32 To make octbstack.a in release mode:
  33         make PLATFORM=arduinomega (For Arduino Due, use <arduinodue>)
  34
  35 To make octbstack.a in debug mode:
  36         make PLATFORM=arduinomega BUILD=debug (For Arduino Due, use <arduinodue>)
  37
  38 To make octbstack.a with Arduino WiFi Shield support:
  39         make PLATFORM=arduinomega ARDUINOWIFI=1 (For Arduino Due, use <arduinodue>)
  40
  41 Dependencies:
  42     1) Patch the Wiznet Ethernet library with the patch available at :
  43     oic-utilities/tb/arduino_linux_ethernet_socket_cpp.patch
  44     2) Arduino builds are dependent on latest Time library. Download it from here:
  45     http://www.pjrc.com/teensy/td_libs_Time.html
  46     3) Arduino Due has been tested with Arduino 1.5.7 framework.
  47     4) For Arduino Due, binary tools are located in:
  48        /hardware/tools/gcc-arm-none-eabi-4.8.3-2014q1/bin
  49     5) For Arduino WiFi, update the WiFi shield with the firmware patches provided
  50        by Intel.
  51 -------------------------------------------------------------------------------
  52 **Clean-Up**
  53 -------------------------------------------------------------------------------
  54 To clean only stack modules:
  55
  56         make clean
  57
  58 To clean stack modules and libcoap (i.e. networking) modules & its
  59 dependencies:
  60
  61         make deepclean
  62